diff --git a/cli/builds.go b/cli/builds.go new file mode 100644 index 0000000000000..b54d0bc0493d6 --- /dev/null +++ b/cli/builds.go @@ -0,0 +1,104 @@ +package cli + +import ( + "fmt" + "strconv" + "time" + + "golang.org/x/xerrors" + + "github.com/coder/coder/v2/cli/cliui" + "github.com/coder/coder/v2/codersdk" + "github.com/coder/serpent" +) + +type workspaceBuildListRow struct { + codersdk.WorkspaceBuild `table:"-"` + + BuildNumber string `json:"-" table:"build,default_sort"` + BuildID string `json:"-" table:"build id"` + Status string `json:"-" table:"status"` + Reason string `json:"-" table:"reason"` + CreatedAt string `json:"-" table:"created"` + Duration string `json:"-" table:"duration"` +} + +func workspaceBuildListRowFromBuild(build codersdk.WorkspaceBuild) workspaceBuildListRow { + status := codersdk.WorkspaceDisplayStatus(build.Job.Status, build.Transition) + createdAt := build.CreatedAt.Format("2006-01-02 15:04:05") + + duration := "" + if build.Job.CompletedAt != nil { + duration = build.Job.CompletedAt.Sub(build.CreatedAt).Truncate(time.Second).String() + } + + return workspaceBuildListRow{ + WorkspaceBuild: build, + BuildNumber: strconv.Itoa(int(build.BuildNumber)), + BuildID: build.ID.String(), + Status: status, + Reason: string(build.Reason), + CreatedAt: createdAt, + Duration: duration, + } +} + +func (r *RootCmd) builds() *serpent.Command { + return &serpent.Command{ + Use: "builds", + Short: "Manage workspace builds", + Children: []*serpent.Command{ + r.buildsList(), + }, + Handler: func(inv *serpent.Invocation) error { + return inv.Command.HelpHandler(inv) + }, + } +} + +func (r *RootCmd) buildsList() *serpent.Command { + formatter := cliui.NewOutputFormatter( + cliui.TableFormat( + []workspaceBuildListRow{}, + []string{"build", "build id", "status", "reason", "created", "duration"}, + ), + cliui.JSONFormat(), + ) + client := new(codersdk.Client) + cmd := &serpent.Command{ + Annotations: workspaceCommand, + Use: "list ", + Short: "List builds for a workspace", + Aliases: []string{"ls"}, + Middleware: serpent.Chain( + serpent.RequireNArgs(1), + r.InitClient(client), + ), + Handler: func(inv *serpent.Invocation) error { + workspace, err := namedWorkspace(inv.Context(), client, inv.Args[0]) + if err != nil { + return xerrors.Errorf("get workspace: %w", err) + } + + builds, err := client.WorkspaceBuildsByWorkspaceID(inv.Context(), workspace.ID) + if err != nil { + return xerrors.Errorf("get workspace builds: %w", err) + } + + rows := make([]workspaceBuildListRow, len(builds)) + for i, build := range builds { + rows[i] = workspaceBuildListRowFromBuild(build) + } + + out, err := formatter.Format(inv.Context(), rows) + if err != nil { + return err + } + + _, err = fmt.Fprintln(inv.Stdout, out) + return err + }, + } + formatter.AttachOptions(&cmd.Options) + return cmd +} diff --git a/cli/builds_test.go b/cli/builds_test.go new file mode 100644 index 0000000000000..bf7aeb59724f1 --- /dev/null +++ b/cli/builds_test.go @@ -0,0 +1,101 @@ +package cli_test + +import ( + "bytes" + "context" + "encoding/json" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/coder/coder/v2/cli/clitest" + "github.com/coder/coder/v2/coderd/coderdtest" + "github.com/coder/coder/v2/coderd/database" + "github.com/coder/coder/v2/coderd/database/dbfake" + "github.com/coder/coder/v2/codersdk" + "github.com/coder/coder/v2/pty/ptytest" + "github.com/coder/coder/v2/testutil" +) + +func TestBuildsList(t *testing.T) { + t.Parallel() + + t.Run("Table", func(t *testing.T) { + t.Parallel() + client, db := coderdtest.NewWithDatabase(t, nil) + owner := coderdtest.CreateFirstUser(t, client) + member, memberUser := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID) + + // Create a workspace with a build + r := dbfake.WorkspaceBuild(t, db, database.WorkspaceTable{ + OrganizationID: owner.OrganizationID, + OwnerID: memberUser.ID, + }).WithAgent().Do() + + inv, root := clitest.New(t, "builds", "list", r.Workspace.Name) + clitest.SetupConfig(t, member, root) + pty := ptytest.New(t).Attach(inv) + + ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong) + defer cancelFunc() + + done := make(chan any) + go func() { + errC := inv.WithContext(ctx).Run() + assert.NoError(t, errC) + close(done) + }() + + pty.ExpectMatch("1") // Build number + pty.ExpectMatch(r.Build.ID.String()) // Build ID + cancelFunc() + <-done + }) + + t.Run("JSON", func(t *testing.T) { + t.Parallel() + client, db := coderdtest.NewWithDatabase(t, nil) + owner := coderdtest.CreateFirstUser(t, client) + member, memberUser := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID) + + // Create a workspace with a build + r := dbfake.WorkspaceBuild(t, db, database.WorkspaceTable{ + OrganizationID: owner.OrganizationID, + OwnerID: memberUser.ID, + }).WithAgent().Do() + + inv, root := clitest.New(t, "builds", "list", r.Workspace.Name, "--output=json") + clitest.SetupConfig(t, member, root) + + ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong) + defer cancelFunc() + + out := bytes.NewBuffer(nil) + inv.Stdout = out + err := inv.WithContext(ctx).Run() + require.NoError(t, err) + + var builds []codersdk.WorkspaceBuild + require.NoError(t, json.Unmarshal(out.Bytes(), &builds)) + require.Len(t, builds, 1) + assert.Equal(t, r.Build.ID, builds[0].ID) + }) + + t.Run("WorkspaceNotFound", func(t *testing.T) { + t.Parallel() + client := coderdtest.New(t, nil) + owner := coderdtest.CreateFirstUser(t, client) + member, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID) + + inv, root := clitest.New(t, "builds", "list", "non-existent-workspace") + clitest.SetupConfig(t, member, root) + + ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong) + defer cancelFunc() + + err := inv.WithContext(ctx).Run() + require.Error(t, err) + assert.Contains(t, err.Error(), "get workspace") + }) +} diff --git a/cli/logs.go b/cli/logs.go new file mode 100644 index 0000000000000..d44b8a63edda5 --- /dev/null +++ b/cli/logs.go @@ -0,0 +1,67 @@ +package cli + +import ( + "fmt" + + "github.com/google/uuid" + "golang.org/x/xerrors" + + "github.com/coder/coder/v2/codersdk" + "github.com/coder/serpent" +) + +func (r *RootCmd) logs() *serpent.Command { + var follow bool + client := new(codersdk.Client) + cmd := &serpent.Command{ + Annotations: workspaceCommand, + Use: "logs ", + Short: "Show logs for a workspace build", + Middleware: serpent.Chain( + serpent.RequireNArgs(1), + r.InitClient(client), + ), + Handler: func(inv *serpent.Invocation) error { + buildIDStr := inv.Args[0] + buildID, err := uuid.Parse(buildIDStr) + if err != nil { + return xerrors.Errorf("invalid build ID %q: %w", buildIDStr, err) + } + + logs, closer, err := client.WorkspaceBuildLogsAfter(inv.Context(), buildID, 0) + if err != nil { + return xerrors.Errorf("get build logs: %w", err) + } + defer closer.Close() + + for { + log, ok := <-logs + if !ok { + break + } + + // Simple format with timestamp and stage + timestamp := log.CreatedAt.Format("15:04:05") + if log.Stage != "" { + _, _ = fmt.Fprintf(inv.Stdout, "[%s] %s: %s\n", + timestamp, log.Stage, log.Output) + } else { + _, _ = fmt.Fprintf(inv.Stdout, "[%s] %s\n", + timestamp, log.Output) + } + } + return nil + }, + } + + cmd.Options = serpent.OptionSet{ + { + Flag: "follow", + FlagShorthand: "f", + Description: "Follow log output (stream real-time logs).", + Value: serpent.BoolOf(&follow), + }, + } + + return cmd +} diff --git a/cli/logs_test.go b/cli/logs_test.go new file mode 100644 index 0000000000000..49a4d07538eb6 --- /dev/null +++ b/cli/logs_test.go @@ -0,0 +1,53 @@ +package cli_test + +import ( + "context" + "strings" + "testing" + + "github.com/google/uuid" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/coder/coder/v2/cli/clitest" + "github.com/coder/coder/v2/coderd/coderdtest" + "github.com/coder/coder/v2/testutil" +) + +func TestLogs(t *testing.T) { + t.Parallel() + + t.Run("LogsInvalidBuildID", func(t *testing.T) { + t.Parallel() + + client := coderdtest.New(t, nil) + _ = coderdtest.CreateFirstUser(t, client) + + inv, root := clitest.New(t, "logs", "invalid-uuid") + clitest.SetupConfig(t, client, root) + + ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitMedium) + defer cancelFunc() + + err := inv.WithContext(ctx).Run() + require.Error(t, err) + assert.True(t, strings.Contains(err.Error(), "invalid build ID")) + }) + + t.Run("LogsNonexistentBuild", func(t *testing.T) { + t.Parallel() + + client := coderdtest.New(t, nil) + _ = coderdtest.CreateFirstUser(t, client) + + inv, root := clitest.New(t, "logs", uuid.New().String()) + clitest.SetupConfig(t, client, root) + + ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitMedium) + defer cancelFunc() + + err := inv.WithContext(ctx).Run() + require.Error(t, err) + assert.True(t, strings.Contains(err.Error(), "get build logs")) + }) +} diff --git a/cli/root.go b/cli/root.go index 54215a67401dd..19ed4c07fe825 100644 --- a/cli/root.go +++ b/cli/root.go @@ -107,11 +107,13 @@ func (r *RootCmd) CoreSubcommands() []*serpent.Command { // Workspace Commands r.autoupdate(), + r.builds(), r.configSSH(), r.create(), r.deleteWorkspace(), r.favorite(), r.list(), + r.logs(), r.open(), r.ping(), r.rename(), diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden index 09dd4c3bce3a5..64da9f32299c2 100644 --- a/cli/testdata/coder_--help.golden +++ b/cli/testdata/coder_--help.golden @@ -15,6 +15,7 @@ USAGE: SUBCOMMANDS: autoupdate Toggle auto-update policy for a workspace + builds Manage workspace builds completion Install or update shell completion scripts for the detected or chosen shell. config-ssh Add an SSH Host entry for your workspaces "ssh @@ -28,6 +29,7 @@ SUBCOMMANDS: list List workspaces login Authenticate with Coder deployment logout Unauthenticate your local session + logs Show logs for a workspace build netcheck Print network debug information for DERP and STUN notifications Manage Coder notifications open Open a workspace diff --git a/cli/testdata/coder_builds_--help.golden b/cli/testdata/coder_builds_--help.golden new file mode 100644 index 0000000000000..c51c3adb6425d --- /dev/null +++ b/cli/testdata/coder_builds_--help.golden @@ -0,0 +1,12 @@ +coder v0.0.0-devel + +USAGE: + coder builds + + Manage workspace builds + +SUBCOMMANDS: + list List builds for a workspace + +——— +Run `coder --help` for a list of global options. diff --git a/cli/testdata/coder_builds_list_--help.golden b/cli/testdata/coder_builds_list_--help.golden new file mode 100644 index 0000000000000..38276d5694666 --- /dev/null +++ b/cli/testdata/coder_builds_list_--help.golden @@ -0,0 +1,18 @@ +coder v0.0.0-devel + +USAGE: + coder builds list [flags] + + List builds for a workspace + + Aliases: ls + +OPTIONS: + -c, --column [build|build id|status|reason|created|duration] (default: build,build id,status,reason,created,duration) + Columns to display in table output. + + -o, --output table|json (default: table) + Output format. + +——— +Run `coder --help` for a list of global options. diff --git a/cli/testdata/coder_logs_--help.golden b/cli/testdata/coder_logs_--help.golden new file mode 100644 index 0000000000000..96aceb90353f2 --- /dev/null +++ b/cli/testdata/coder_logs_--help.golden @@ -0,0 +1,13 @@ +coder v0.0.0-devel + +USAGE: + coder logs [flags] + + Show logs for a workspace build + +OPTIONS: + -f, --follow bool + Follow log output (stream real-time logs). + +——— +Run `coder --help` for a list of global options. diff --git a/codersdk/workspacebuilds.go b/codersdk/workspacebuilds.go index 53d2a89290bca..df9d5a8dfec73 100644 --- a/codersdk/workspacebuilds.go +++ b/codersdk/workspacebuilds.go @@ -279,3 +279,14 @@ func (c *Client) WorkspaceBuildTimings(ctx context.Context, build uuid.UUID) (Wo var timings WorkspaceBuildTimings return timings, json.NewDecoder(res.Body).Decode(&timings) } + +func (c *Client) WorkspaceBuildsByWorkspaceID(ctx context.Context, workspaceID uuid.UUID) ([]WorkspaceBuild, error) { + res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/workspaces/%s/builds", workspaceID), nil) + if err != nil { + return nil, err + } + defer res.Body.Close() + + var builds []WorkspaceBuild + return builds, json.NewDecoder(res.Body).Decode(&builds) +} diff --git a/docs/manifest.json b/docs/manifest.json index 0305105c029fd..b34c1272e06ad 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1128,6 +1128,16 @@ "description": "Toggle auto-update policy for a workspace", "path": "reference/cli/autoupdate.md" }, + { + "title": "builds", + "description": "Manage workspace builds", + "path": "reference/cli/builds.md" + }, + { + "title": "builds list", + "description": "List builds for a workspace", + "path": "reference/cli/builds_list.md" + }, { "title": "coder", "path": "reference/cli/index.md" @@ -1241,6 +1251,11 @@ "description": "Unauthenticate your local session", "path": "reference/cli/logout.md" }, + { + "title": "logs", + "description": "Show logs for a workspace build", + "path": "reference/cli/logs.md" + }, { "title": "netcheck", "description": "Print network debug information for DERP and STUN", diff --git a/docs/reference/api/agents.md b/docs/reference/api/agents.md index 54e9b0e6ad628..31ae993c7b8d0 100644 --- a/docs/reference/api/agents.md +++ b/docs/reference/api/agents.md @@ -14,9 +14,9 @@ curl -X GET http://coder-server:8080/api/v2/derp-map \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------------------|---------------------|--------| -| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|101|[Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2)|Switching Protocols|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -34,9 +34,9 @@ curl -X GET http://coder-server:8080/api/v2/tailnet \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------------------|---------------------|--------| -| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|101|[Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2)|Switching Protocols|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -65,9 +65,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/aws-instance-identi ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------|----------|-------------------------| -| `body` | body | [agentsdk.AWSInstanceIdentityToken](schemas.md#agentsdkawsinstanceidentitytoken) | true | Instance identity token | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[agentsdk.AWSInstanceIdentityToken](schemas.md#agentsdkawsinstanceidentitytoken)|true|Instance identity token| ### Example responses @@ -81,9 +81,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/aws-instance-identi ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -112,9 +112,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/azure-instance-iden ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------------------------|----------|-------------------------| -| `body` | body | [agentsdk.AzureInstanceIdentityToken](schemas.md#agentsdkazureinstanceidentitytoken) | true | Instance identity token | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[agentsdk.AzureInstanceIdentityToken](schemas.md#agentsdkazureinstanceidentitytoken)|true|Instance identity token| ### Example responses @@ -128,9 +128,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/azure-instance-iden ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -158,9 +158,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/google-instance-ide ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------------|----------|-------------------------| -| `body` | body | [agentsdk.GoogleInstanceIdentityToken](schemas.md#agentsdkgoogleinstanceidentitytoken) | true | Instance identity token | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[agentsdk.GoogleInstanceIdentityToken](schemas.md#agentsdkgoogleinstanceidentitytoken)|true|Instance identity token| ### Example responses @@ -174,9 +174,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/google-instance-ide ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -209,9 +209,9 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/app-status \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------|----------|-------------| -| `body` | body | [agentsdk.PatchAppStatus](schemas.md#agentsdkpatchappstatus) | true | app status | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[agentsdk.PatchAppStatus](schemas.md#agentsdkpatchappstatus)|true|app status| ### Example responses @@ -232,9 +232,9 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/app-status \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -253,11 +253,11 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/external-auth?mat ### Parameters -| Name | In | Type | Required | Description | -|----------|-------|---------|----------|-----------------------------------| -| `match` | query | string | true | Match | -| `id` | query | string | true | Provider ID | -| `listen` | query | boolean | false | Wait for a new token to be issued | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`match`|query|string|true|Match| +|`id`|query|string|true|Provider ID| +|`listen`|query|boolean|false|Wait for a new token to be issued| ### Example responses @@ -276,9 +276,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/external-auth?mat ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.ExternalAuthResponse](schemas.md#agentsdkexternalauthresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[agentsdk.ExternalAuthResponse](schemas.md#agentsdkexternalauthresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -297,11 +297,11 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitauth?match=str ### Parameters -| Name | In | Type | Required | Description | -|----------|-------|---------|----------|-----------------------------------| -| `match` | query | string | true | Match | -| `id` | query | string | true | Provider ID | -| `listen` | query | boolean | false | Wait for a new token to be issued | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`match`|query|string|true|Match| +|`id`|query|string|true|Provider ID| +|`listen`|query|boolean|false|Wait for a new token to be issued| ### Example responses @@ -320,9 +320,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitauth?match=str ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.ExternalAuthResponse](schemas.md#agentsdkexternalauthresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[agentsdk.ExternalAuthResponse](schemas.md#agentsdkexternalauthresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -352,9 +352,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitsshkey \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.GitSSHKey](schemas.md#agentsdkgitsshkey) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[agentsdk.GitSSHKey](schemas.md#agentsdkgitsshkey)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -384,9 +384,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/log-source \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------------|----------|--------------------| -| `body` | body | [agentsdk.PostLogSourceRequest](schemas.md#agentsdkpostlogsourcerequest) | true | Log source request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[agentsdk.PostLogSourceRequest](schemas.md#agentsdkpostlogsourcerequest)|true|Log source request| ### Example responses @@ -404,9 +404,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/log-source \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentLogSource](schemas.md#codersdkworkspaceagentlogsource) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceAgentLogSource](schemas.md#codersdkworkspaceagentlogsource)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -441,9 +441,9 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/logs \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------|----------|-------------| -| `body` | body | [agentsdk.PatchLogs](schemas.md#agentsdkpatchlogs) | true | logs | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[agentsdk.PatchLogs](schemas.md#agentsdkpatchlogs)|true|logs| ### Example responses @@ -464,9 +464,9 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/logs \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -496,9 +496,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/reinit \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.ReinitializationEvent](schemas.md#agentsdkreinitializationevent) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[agentsdk.ReinitializationEvent](schemas.md#agentsdkreinitializationevent)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -517,9 +517,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \ ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|--------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| ### Example responses @@ -644,9 +644,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgent](schemas.md#codersdkworkspaceagent) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceAgent](schemas.md#codersdkworkspaceagent)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -665,9 +665,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|--------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| ### Example responses @@ -742,9 +742,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [workspacesdk.AgentConnectionInfo](schemas.md#workspacesdkagentconnectioninfo) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[workspacesdk.AgentConnectionInfo](schemas.md#workspacesdkagentconnectioninfo)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -763,10 +763,10 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con ### Parameters -| Name | In | Type | Required | Description | -|------------------|-------|-------------------|----------|--------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | -| `label` | query | string(key=value) | true | Labels | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| +|`label`|query|string(key=value)|true|Labels| ### Example responses @@ -848,9 +848,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentListContainersResponse](schemas.md#codersdkworkspaceagentlistcontainersresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceAgentListContainersResponse](schemas.md#codersdkworkspaceagentlistcontainersresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -869,10 +869,10 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/co ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|--------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | -| `devcontainer` | path | string | true | Devcontainer ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| +|`devcontainer`|path|string|true|Devcontainer ID| ### Example responses @@ -893,9 +893,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/co ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------------|-------------|--------------------------------------------------| -| 202 | [Accepted](https://tools.ietf.org/html/rfc7231#section-6.3.3) | Accepted | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|202|[Accepted](https://tools.ietf.org/html/rfc7231#section-6.3.3)|Accepted|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -914,9 +914,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|--------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| ### Example responses @@ -998,9 +998,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentListContainersResponse](schemas.md#codersdkworkspaceagentlistcontainersresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceAgentListContainersResponse](schemas.md#codersdkworkspaceagentlistcontainersresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1018,15 +1018,15 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/coo ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|--------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------------------|---------------------|--------| -| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|101|[Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2)|Switching Protocols|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1045,9 +1045,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/lis ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|--------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| ### Example responses @@ -1067,9 +1067,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/lis ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentListeningPortsResponse](schemas.md#codersdkworkspaceagentlisteningportsresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceAgentListeningPortsResponse](schemas.md#codersdkworkspaceagentlisteningportsresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1088,13 +1088,13 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/log ### Parameters -| Name | In | Type | Required | Description | -|------------------|-------|--------------|----------|----------------------------------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | -| `before` | query | integer | false | Before log id | -| `after` | query | integer | false | After log id | -| `follow` | query | boolean | false | Follow log stream | -| `no_compression` | query | boolean | false | Disable compression for WebSocket connection | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| +|`before`|query|integer|false|Before log id| +|`after`|query|integer|false|After log id| +|`follow`|query|boolean|false|Follow log stream| +|`no_compression`|query|boolean|false|Disable compression for WebSocket connection| ### Example responses @@ -1114,32 +1114,32 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/log ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceAgentLog](schemas.md#codersdkworkspaceagentlog) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.WorkspaceAgentLog](schemas.md#codersdkworkspaceagentlog)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|--------------------------------------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | false | | | -| `» id` | integer | false | | | -| `» level` | [codersdk.LogLevel](schemas.md#codersdkloglevel) | false | | | -| `» output` | string | false | | | -| `» source_id` | string(uuid) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|false||| +|`» id`|integer|false||| +|`» level`|[codersdk.LogLevel](schemas.md#codersdkloglevel)|false||| +|`» output`|string|false||| +|`» source_id`|string(uuid)|false||| #### Enumerated Values -| Property | Value | -|----------|---------| -| `level` | `trace` | -| `level` | `debug` | -| `level` | `info` | -| `level` | `warn` | -| `level` | `error` | +|Property|Value| +|---|---| +|`level`|`trace`| +|`level`|`debug`| +|`level`|`info`| +|`level`|`warn`| +|`level`|`error`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1157,15 +1157,15 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/pty ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|--------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------------------|---------------------|--------| -| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|101|[Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2)|Switching Protocols|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1184,13 +1184,13 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/sta ### Parameters -| Name | In | Type | Required | Description | -|------------------|-------|--------------|----------|----------------------------------------------| -| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | -| `before` | query | integer | false | Before log id | -| `after` | query | integer | false | After log id | -| `follow` | query | boolean | false | Follow log stream | -| `no_compression` | query | boolean | false | Disable compression for WebSocket connection | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceagent`|path|string(uuid)|true|Workspace agent ID| +|`before`|query|integer|false|Before log id| +|`after`|query|integer|false|After log id| +|`follow`|query|boolean|false|Follow log stream| +|`no_compression`|query|boolean|false|Disable compression for WebSocket connection| ### Example responses @@ -1210,31 +1210,31 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/sta ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceAgentLog](schemas.md#codersdkworkspaceagentlog) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.WorkspaceAgentLog](schemas.md#codersdkworkspaceagentlog)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|--------------------------------------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | false | | | -| `» id` | integer | false | | | -| `» level` | [codersdk.LogLevel](schemas.md#codersdkloglevel) | false | | | -| `» output` | string | false | | | -| `» source_id` | string(uuid) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|false||| +|`» id`|integer|false||| +|`» level`|[codersdk.LogLevel](schemas.md#codersdkloglevel)|false||| +|`» output`|string|false||| +|`» source_id`|string(uuid)|false||| #### Enumerated Values -| Property | Value | -|----------|---------| -| `level` | `trace` | -| `level` | `debug` | -| `level` | `info` | -| `level` | `warn` | -| `level` | `error` | +|Property|Value| +|---|---| +|`level`|`trace`| +|`level`|`debug`| +|`level`|`info`| +|`level`|`warn`| +|`level`|`error`| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/applications.md b/docs/reference/api/applications.md index 77fe7095ee9db..789c33892047e 100644 --- a/docs/reference/api/applications.md +++ b/docs/reference/api/applications.md @@ -14,15 +14,15 @@ curl -X GET http://coder-server:8080/api/v2/applications/auth-redirect \ ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|--------|----------|----------------------| -| `redirect_uri` | query | string | false | Redirect destination | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`redirect_uri`|query|string|false|Redirect destination| ### Responses -| Status | Meaning | Description | Schema | -|--------|-------------------------------------------------------------------------|--------------------|--------| -| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|307|[Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7)|Temporary Redirect|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -51,8 +51,8 @@ curl -X GET http://coder-server:8080/api/v2/applications/host \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AppHostResponse](schemas.md#codersdkapphostresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.AppHostResponse](schemas.md#codersdkapphostresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/audit.md b/docs/reference/api/audit.md index c717a75d51e54..3243223333150 100644 --- a/docs/reference/api/audit.md +++ b/docs/reference/api/audit.md @@ -15,11 +15,11 @@ curl -X GET http://coder-server:8080/api/v2/audit?limit=0 \ ### Parameters -| Name | In | Type | Required | Description | -|----------|-------|---------|----------|--------------| -| `q` | query | string | false | Search query | -| `limit` | query | integer | true | Page limit | -| `offset` | query | integer | false | Page offset | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`q`|query|string|false|Search query| +|`limit`|query|integer|true|Page limit| +|`offset`|query|integer|false|Page offset| ### Example responses @@ -94,8 +94,8 @@ curl -X GET http://coder-server:8080/api/v2/audit?limit=0 \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuditLogResponse](schemas.md#codersdkauditlogresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.AuditLogResponse](schemas.md#codersdkauditlogresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/authorization.md b/docs/reference/api/authorization.md index 3565a8c922135..34d5cf38664ca 100644 --- a/docs/reference/api/authorization.md +++ b/docs/reference/api/authorization.md @@ -45,9 +45,9 @@ curl -X POST http://coder-server:8080/api/v2/authcheck \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------------|----------|-----------------------| -| `body` | body | [codersdk.AuthorizationRequest](schemas.md#codersdkauthorizationrequest) | true | Authorization request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.AuthorizationRequest](schemas.md#codersdkauthorizationrequest)|true|Authorization request| ### Example responses @@ -62,9 +62,9 @@ curl -X POST http://coder-server:8080/api/v2/authcheck \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuthorizationResponse](schemas.md#codersdkauthorizationresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.AuthorizationResponse](schemas.md#codersdkauthorizationresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -92,9 +92,9 @@ curl -X POST http://coder-server:8080/api/v2/users/login \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------|----------|---------------| -| `body` | body | [codersdk.LoginWithPasswordRequest](schemas.md#codersdkloginwithpasswordrequest) | true | Login request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.LoginWithPasswordRequest](schemas.md#codersdkloginwithpasswordrequest)|true|Login request| ### Example responses @@ -108,9 +108,9 @@ curl -X POST http://coder-server:8080/api/v2/users/login \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.LoginWithPasswordResponse](schemas.md#codersdkloginwithpasswordresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.LoginWithPasswordResponse](schemas.md#codersdkloginwithpasswordresponse)| ## Change password with a one-time passcode @@ -136,15 +136,15 @@ curl -X POST http://coder-server:8080/api/v2/users/otp/change-password \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------------------------------------------|----------|-------------------------| -| `body` | body | [codersdk.ChangePasswordWithOneTimePasscodeRequest](schemas.md#codersdkchangepasswordwithonetimepasscoderequest) | true | Change password request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.ChangePasswordWithOneTimePasscodeRequest](schemas.md#codersdkchangepasswordwithonetimepasscoderequest)|true|Change password request| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| ## Request one-time passcode @@ -168,15 +168,15 @@ curl -X POST http://coder-server:8080/api/v2/users/otp/request \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------------------------------|----------|---------------------------| -| `body` | body | [codersdk.RequestOneTimePasscodeRequest](schemas.md#codersdkrequestonetimepasscoderequest) | true | One-time passcode request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.RequestOneTimePasscodeRequest](schemas.md#codersdkrequestonetimepasscoderequest)|true|One-time passcode request| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| ## Validate user password @@ -202,9 +202,9 @@ curl -X POST http://coder-server:8080/api/v2/users/validate-password \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------------|----------|--------------------------------| -| `body` | body | [codersdk.ValidateUserPasswordRequest](schemas.md#codersdkvalidateuserpasswordrequest) | true | Validate user password request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.ValidateUserPasswordRequest](schemas.md#codersdkvalidateuserpasswordrequest)|true|Validate user password request| ### Example responses @@ -219,9 +219,9 @@ curl -X POST http://coder-server:8080/api/v2/users/validate-password \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ValidateUserPasswordResponse](schemas.md#codersdkvalidateuserpasswordresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ValidateUserPasswordResponse](schemas.md#codersdkvalidateuserpasswordresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -250,10 +250,10 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/convert-login \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `body` | body | [codersdk.ConvertLoginRequest](schemas.md#codersdkconvertloginrequest) | true | Convert request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`body`|body|[codersdk.ConvertLoginRequest](schemas.md#codersdkconvertloginrequest)|true|Convert request| ### Example responses @@ -270,8 +270,8 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/convert-login \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.OAuthConversionResponse](schemas.md#codersdkoauthconversionresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.OAuthConversionResponse](schemas.md#codersdkoauthconversionresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/builds.md b/docs/reference/api/builds.md index fb491405df362..c760ec7d2959d 100644 --- a/docs/reference/api/builds.md +++ b/docs/reference/api/builds.md @@ -15,11 +15,11 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam ### Parameters -| Name | In | Type | Required | Description | -|-----------------|------|----------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `workspacename` | path | string | true | Workspace name | -| `buildnumber` | path | string(number) | true | Build number | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`workspacename`|path|string|true|Workspace name| +|`buildnumber`|path|string(number)|true|Build number| ### Example responses @@ -233,9 +233,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -254,9 +254,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \ ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------|----------|--------------------| -| `workspacebuild` | path | string | true | Workspace build ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspacebuild`|path|string|true|Workspace build ID| ### Example responses @@ -470,9 +470,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -491,17 +491,17 @@ curl -X PATCH http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/c ### Parameters -| Name | In | Type | Required | Description | -|------------------|-------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `workspacebuild` | path | string | true | Workspace build ID | -| `expect_status` | query | string | false | Expected status of the job. If expect_status is supplied, the request will be rejected with 412 Precondition Failed if the job doesn't match the state when performing the cancellation. | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspacebuild`|path|string|true|Workspace build ID| +|`expect_status`|query|string|false|Expected status of the job. If expect_status is supplied, the request will be rejected with 412 Precondition Failed if the job doesn't match the state when performing the cancellation.| #### Enumerated Values -| Parameter | Value | -|-----------------|-----------| -| `expect_status` | `running` | -| `expect_status` | `pending` | +|Parameter|Value| +|---|---| +|`expect_status`|`running`| +|`expect_status`|`pending`| ### Example responses @@ -522,9 +522,9 @@ curl -X PATCH http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/c ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -543,12 +543,12 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/log ### Parameters -| Name | In | Type | Required | Description | -|------------------|-------|---------|----------|--------------------| -| `workspacebuild` | path | string | true | Workspace build ID | -| `before` | query | integer | false | Before log id | -| `after` | query | integer | false | After log id | -| `follow` | query | boolean | false | Follow log stream | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspacebuild`|path|string|true|Workspace build ID| +|`before`|query|integer|false|Before log id| +|`after`|query|integer|false|After log id| +|`follow`|query|boolean|false|Follow log stream| ### Example responses @@ -569,35 +569,35 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/log ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|----------------------------------------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | false | | | -| `» id` | integer | false | | | -| `» log_level` | [codersdk.LogLevel](schemas.md#codersdkloglevel) | false | | | -| `» log_source` | [codersdk.LogSource](schemas.md#codersdklogsource) | false | | | -| `» output` | string | false | | | -| `» stage` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|false||| +|`» id`|integer|false||| +|`» log_level`|[codersdk.LogLevel](schemas.md#codersdkloglevel)|false||| +|`» log_source`|[codersdk.LogSource](schemas.md#codersdklogsource)|false||| +|`» output`|string|false||| +|`» stage`|string|false||| #### Enumerated Values -| Property | Value | -|--------------|----------------------| -| `log_level` | `trace` | -| `log_level` | `debug` | -| `log_level` | `info` | -| `log_level` | `warn` | -| `log_level` | `error` | -| `log_source` | `provisioner_daemon` | -| `log_source` | `provisioner` | +|Property|Value| +|---|---| +|`log_level`|`trace`| +|`log_level`|`debug`| +|`log_level`|`info`| +|`log_level`|`warn`| +|`log_level`|`error`| +|`log_source`|`provisioner_daemon`| +|`log_source`|`provisioner`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -616,9 +616,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/par ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------|----------|--------------------| -| `workspacebuild` | path | string | true | Workspace build ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspacebuild`|path|string|true|Workspace build ID| ### Example responses @@ -635,19 +635,19 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/par ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceBuildParameter](schemas.md#codersdkworkspacebuildparameter) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.WorkspaceBuildParameter](schemas.md#codersdkworkspacebuildparameter)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» name` | string | false | | | -| `» value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» name`|string|false||| +|`» value`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -666,9 +666,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------|----------|--------------------| -| `workspacebuild` | path | string | true | Workspace build ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspacebuild`|path|string|true|Workspace build ID| ### Example responses @@ -815,153 +815,153 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|---------------------------------|--------------------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» agents` | array | false | | | -| `»» api_version` | string | false | | | -| `»» apps` | array | false | | | -| `»»» command` | string | false | | | -| `»»» display_name` | string | false | | Display name is a friendly name for the app. | -| `»»» external` | boolean | false | | External specifies whether the URL should be opened externally on the client or not. | -| `»»» group` | string | false | | | -| `»»» health` | [codersdk.WorkspaceAppHealth](schemas.md#codersdkworkspaceapphealth) | false | | | -| `»»» healthcheck` | [codersdk.Healthcheck](schemas.md#codersdkhealthcheck) | false | | Healthcheck specifies the configuration for checking app health. | -| `»»»» interval` | integer | false | | Interval specifies the seconds between each health check. | -| `»»»» threshold` | integer | false | | Threshold specifies the number of consecutive failed health checks before returning "unhealthy". | -| `»»»» url` | string | false | | URL specifies the endpoint to check for the app health. | -| `»»» hidden` | boolean | false | | | -| `»»» icon` | string | false | | Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. | -| `»»» id` | string(uuid) | false | | | -| `»»» open_in` | [codersdk.WorkspaceAppOpenIn](schemas.md#codersdkworkspaceappopenin) | false | | | -| `»»» sharing_level` | [codersdk.WorkspaceAppSharingLevel](schemas.md#codersdkworkspaceappsharinglevel) | false | | | -| `»»» slug` | string | false | | Slug is a unique identifier within the agent. | -| `»»» statuses` | array | false | | Statuses is a list of statuses for the app. | -| `»»»» agent_id` | string(uuid) | false | | | -| `»»»» app_id` | string(uuid) | false | | | -| `»»»» created_at` | string(date-time) | false | | | -| `»»»» icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. | -| `»»»» id` | string(uuid) | false | | | -| `»»»» message` | string | false | | | -| `»»»» needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. | -| `»»»» state` | [codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate) | false | | | -| `»»»» uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file | -| `»»»» workspace_id` | string(uuid) | false | | | -| `»»» subdomain` | boolean | false | | Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI. | -| `»»» subdomain_name` | string | false | | Subdomain name is the application domain exposed on the `coder server`. | -| `»»» url` | string | false | | URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client. | -| `»» architecture` | string | false | | | -| `»» connection_timeout_seconds` | integer | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» directory` | string | false | | | -| `»» disconnected_at` | string(date-time) | false | | | -| `»» display_apps` | array | false | | | -| `»» environment_variables` | object | false | | | -| `»»» [any property]` | string | false | | | -| `»» expanded_directory` | string | false | | | -| `»» first_connected_at` | string(date-time) | false | | | -| `»» health` | [codersdk.WorkspaceAgentHealth](schemas.md#codersdkworkspaceagenthealth) | false | | Health reports the health of the agent. | -| `»»» healthy` | boolean | false | | Healthy is true if the agent is healthy. | -| `»»» reason` | string | false | | Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true. | -| `»» id` | string(uuid) | false | | | -| `»» instance_id` | string | false | | | -| `»» last_connected_at` | string(date-time) | false | | | -| `»» latency` | object | false | | Latency is mapped by region name (e.g. "New York City", "Seattle"). | -| `»»» [any property]` | [codersdk.DERPRegion](schemas.md#codersdkderpregion) | false | | | -| `»»»» latency_ms` | number | false | | | -| `»»»» preferred` | boolean | false | | | -| `»» lifecycle_state` | [codersdk.WorkspaceAgentLifecycle](schemas.md#codersdkworkspaceagentlifecycle) | false | | | -| `»» log_sources` | array | false | | | -| `»»» created_at` | string(date-time) | false | | | -| `»»» display_name` | string | false | | | -| `»»» icon` | string | false | | | -| `»»» id` | string(uuid) | false | | | -| `»»» workspace_agent_id` | string(uuid) | false | | | -| `»» logs_length` | integer | false | | | -| `»» logs_overflowed` | boolean | false | | | -| `»» name` | string | false | | | -| `»» operating_system` | string | false | | | -| `»» parent_id` | [uuid.NullUUID](schemas.md#uuidnulluuid) | false | | | -| `»»» uuid` | string | false | | | -| `»»» valid` | boolean | false | | Valid is true if UUID is not NULL | -| `»» ready_at` | string(date-time) | false | | | -| `»» resource_id` | string(uuid) | false | | | -| `»» scripts` | array | false | | | -| `»»» cron` | string | false | | | -| `»»» display_name` | string | false | | | -| `»»» id` | string(uuid) | false | | | -| `»»» log_path` | string | false | | | -| `»»» log_source_id` | string(uuid) | false | | | -| `»»» run_on_start` | boolean | false | | | -| `»»» run_on_stop` | boolean | false | | | -| `»»» script` | string | false | | | -| `»»» start_blocks_login` | boolean | false | | | -| `»»» timeout` | integer | false | | | -| `»» started_at` | string(date-time) | false | | | -| `»» startup_script_behavior` | [codersdk.WorkspaceAgentStartupScriptBehavior](schemas.md#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](schemas.md#codersdkworkspaceagentstatus) | false | | | -| `»» subsystems` | array | false | | | -| `»» troubleshooting_url` | string | false | | | -| `»» updated_at` | string(date-time) | false | | | -| `»» version` | string | false | | | -| `» created_at` | string(date-time) | false | | | -| `» daily_cost` | integer | false | | | -| `» hide` | boolean | false | | | -| `» icon` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» job_id` | string(uuid) | false | | | -| `» metadata` | array | false | | | -| `»» key` | string | false | | | -| `»» sensitive` | boolean | false | | | -| `»» value` | string | false | | | -| `» name` | string | false | | | -| `» type` | string | false | | | -| `» workspace_transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» agents`|array|false||| +|`»» api_version`|string|false||| +|`»» apps`|array|false||| +|`»»» command`|string|false||| +|`»»» display_name`|string|false||Display name is a friendly name for the app.| +|`»»» external`|boolean|false||External specifies whether the URL should be opened externally on the client or not.| +|`»»» group`|string|false||| +|`»»» health`|[codersdk.WorkspaceAppHealth](schemas.md#codersdkworkspaceapphealth)|false||| +|`»»» healthcheck`|[codersdk.Healthcheck](schemas.md#codersdkhealthcheck)|false||Healthcheck specifies the configuration for checking app health.| +|`»»»» interval`|integer|false||Interval specifies the seconds between each health check.| +|`»»»» threshold`|integer|false||Threshold specifies the number of consecutive failed health checks before returning "unhealthy".| +|`»»»» url`|string|false||URL specifies the endpoint to check for the app health.| +|`»»» hidden`|boolean|false||| +|`»»» icon`|string|false||Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.| +|`»»» id`|string(uuid)|false||| +|`»»» open_in`|[codersdk.WorkspaceAppOpenIn](schemas.md#codersdkworkspaceappopenin)|false||| +|`»»» sharing_level`|[codersdk.WorkspaceAppSharingLevel](schemas.md#codersdkworkspaceappsharinglevel)|false||| +|`»»» slug`|string|false||Slug is a unique identifier within the agent.| +|`»»» statuses`|array|false||Statuses is a list of statuses for the app.| +|`»»»» agent_id`|string(uuid)|false||| +|`»»»» app_id`|string(uuid)|false||| +|`»»»» created_at`|string(date-time)|false||| +|`»»»» icon`|string|false||Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI.| +|`»»»» id`|string(uuid)|false||| +|`»»»» message`|string|false||| +|`»»»» needs_user_attention`|boolean|false||Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention.| +|`»»»» state`|[codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate)|false||| +|`»»»» uri`|string|false||Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file| +|`»»»» workspace_id`|string(uuid)|false||| +|`»»» subdomain`|boolean|false||Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.| +|`»»» subdomain_name`|string|false||Subdomain name is the application domain exposed on the `coder server`.| +|`»»» url`|string|false||URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.| +|`»» architecture`|string|false||| +|`»» connection_timeout_seconds`|integer|false||| +|`»» created_at`|string(date-time)|false||| +|`»» directory`|string|false||| +|`»» disconnected_at`|string(date-time)|false||| +|`»» display_apps`|array|false||| +|`»» environment_variables`|object|false||| +|`»»» [any property]`|string|false||| +|`»» expanded_directory`|string|false||| +|`»» first_connected_at`|string(date-time)|false||| +|`»» health`|[codersdk.WorkspaceAgentHealth](schemas.md#codersdkworkspaceagenthealth)|false||Health reports the health of the agent.| +|`»»» healthy`|boolean|false||Healthy is true if the agent is healthy.| +|`»»» reason`|string|false||Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.| +|`»» id`|string(uuid)|false||| +|`»» instance_id`|string|false||| +|`»» last_connected_at`|string(date-time)|false||| +|`»» latency`|object|false||Latency is mapped by region name (e.g. "New York City", "Seattle").| +|`»»» [any property]`|[codersdk.DERPRegion](schemas.md#codersdkderpregion)|false||| +|`»»»» latency_ms`|number|false||| +|`»»»» preferred`|boolean|false||| +|`»» lifecycle_state`|[codersdk.WorkspaceAgentLifecycle](schemas.md#codersdkworkspaceagentlifecycle)|false||| +|`»» log_sources`|array|false||| +|`»»» created_at`|string(date-time)|false||| +|`»»» display_name`|string|false||| +|`»»» icon`|string|false||| +|`»»» id`|string(uuid)|false||| +|`»»» workspace_agent_id`|string(uuid)|false||| +|`»» logs_length`|integer|false||| +|`»» logs_overflowed`|boolean|false||| +|`»» name`|string|false||| +|`»» operating_system`|string|false||| +|`»» parent_id`|[uuid.NullUUID](schemas.md#uuidnulluuid)|false||| +|`»»» uuid`|string|false||| +|`»»» valid`|boolean|false||Valid is true if UUID is not NULL| +|`»» ready_at`|string(date-time)|false||| +|`»» resource_id`|string(uuid)|false||| +|`»» scripts`|array|false||| +|`»»» cron`|string|false||| +|`»»» display_name`|string|false||| +|`»»» id`|string(uuid)|false||| +|`»»» log_path`|string|false||| +|`»»» log_source_id`|string(uuid)|false||| +|`»»» run_on_start`|boolean|false||| +|`»»» run_on_stop`|boolean|false||| +|`»»» script`|string|false||| +|`»»» start_blocks_login`|boolean|false||| +|`»»» timeout`|integer|false||| +|`»» started_at`|string(date-time)|false||| +|`»» startup_script_behavior`|[codersdk.WorkspaceAgentStartupScriptBehavior](schemas.md#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](schemas.md#codersdkworkspaceagentstatus)|false||| +|`»» subsystems`|array|false||| +|`»» troubleshooting_url`|string|false||| +|`»» updated_at`|string(date-time)|false||| +|`»» version`|string|false||| +|`» created_at`|string(date-time)|false||| +|`» daily_cost`|integer|false||| +|`» hide`|boolean|false||| +|`» icon`|string|false||| +|`» id`|string(uuid)|false||| +|`» job_id`|string(uuid)|false||| +|`» metadata`|array|false||| +|`»» key`|string|false||| +|`»» sensitive`|boolean|false||| +|`»» value`|string|false||| +|`» name`|string|false||| +|`» type`|string|false||| +|`» workspace_transition`|[codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition)|false||| #### Enumerated Values -| Property | Value | -|---------------------------|--------------------| -| `health` | `disabled` | -| `health` | `initializing` | -| `health` | `healthy` | -| `health` | `unhealthy` | -| `open_in` | `slim-window` | -| `open_in` | `tab` | -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | -| `state` | `working` | -| `state` | `idle` | -| `state` | `complete` | -| `state` | `failure` | -| `lifecycle_state` | `created` | -| `lifecycle_state` | `starting` | -| `lifecycle_state` | `start_timeout` | -| `lifecycle_state` | `start_error` | -| `lifecycle_state` | `ready` | -| `lifecycle_state` | `shutting_down` | -| `lifecycle_state` | `shutdown_timeout` | -| `lifecycle_state` | `shutdown_error` | -| `lifecycle_state` | `off` | -| `startup_script_behavior` | `blocking` | -| `startup_script_behavior` | `non-blocking` | -| `status` | `connecting` | -| `status` | `connected` | -| `status` | `disconnected` | -| `status` | `timeout` | -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | +|Property|Value| +|---|---| +|`health`|`disabled`| +|`health`|`initializing`| +|`health`|`healthy`| +|`health`|`unhealthy`| +|`open_in`|`slim-window`| +|`open_in`|`tab`| +|`sharing_level`|`owner`| +|`sharing_level`|`authenticated`| +|`sharing_level`|`organization`| +|`sharing_level`|`public`| +|`state`|`working`| +|`state`|`idle`| +|`state`|`complete`| +|`state`|`failure`| +|`lifecycle_state`|`created`| +|`lifecycle_state`|`starting`| +|`lifecycle_state`|`start_timeout`| +|`lifecycle_state`|`start_error`| +|`lifecycle_state`|`ready`| +|`lifecycle_state`|`shutting_down`| +|`lifecycle_state`|`shutdown_timeout`| +|`lifecycle_state`|`shutdown_error`| +|`lifecycle_state`|`off`| +|`startup_script_behavior`|`blocking`| +|`startup_script_behavior`|`non-blocking`| +|`status`|`connecting`| +|`status`|`connected`| +|`status`|`disconnected`| +|`status`|`timeout`| +|`workspace_transition`|`start`| +|`workspace_transition`|`stop`| +|`workspace_transition`|`delete`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -980,9 +980,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------|----------|--------------------| -| `workspacebuild` | path | string | true | Workspace build ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspacebuild`|path|string|true|Workspace build ID| ### Example responses @@ -1196,9 +1196,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1217,9 +1217,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/tim ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|--------------------| -| `workspacebuild` | path | string(uuid) | true | Workspace build ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspacebuild`|path|string(uuid)|true|Workspace build ID| ### Example responses @@ -1264,9 +1264,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/tim ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuildTimings](schemas.md#codersdkworkspacebuildtimings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceBuildTimings](schemas.md#codersdkworkspacebuildtimings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1285,13 +1285,13 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|-------|-------------------|----------|-----------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `after_id` | query | string(uuid) | false | After ID | -| `limit` | query | integer | false | Page limit | -| `offset` | query | integer | false | Page offset | -| `since` | query | string(date-time) | false | Since timestamp | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`after_id`|query|string(uuid)|false|After ID| +|`limit`|query|integer|false|Page limit| +|`offset`|query|integer|false|Page offset| +|`since`|query|string(date-time)|false|Since timestamp| ### Example responses @@ -1507,237 +1507,237 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------------------------|--------------------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» ai_task_sidebar_app_id` | string(uuid) | false | | | -| `» build_number` | integer | false | | | -| `» created_at` | string(date-time) | false | | | -| `» daily_cost` | integer | false | | | -| `» deadline` | string(date-time) | false | | | -| `» has_ai_task` | boolean | false | | | -| `» id` | string(uuid) | false | | | -| `» initiator_id` | string(uuid) | false | | | -| `» initiator_name` | string | false | | | -| `» job` | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | false | | | -| `»» available_workers` | array | false | | | -| `»» canceled_at` | string(date-time) | false | | | -| `»» completed_at` | string(date-time) | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» error` | string | false | | | -| `»» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | | -| `»» file_id` | string(uuid) | false | | | -| `»» id` | string(uuid) | false | | | -| `»» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | | -| `»»» error` | string | false | | | -| `»»» template_version_id` | string(uuid) | false | | | -| `»»» workspace_build_id` | string(uuid) | false | | | -| `»» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | | -| `»»» template_display_name` | string | false | | | -| `»»» template_icon` | string | false | | | -| `»»» template_id` | string(uuid) | false | | | -| `»»» template_name` | string | false | | | -| `»»» template_version_name` | string | false | | | -| `»»» workspace_id` | string(uuid) | false | | | -| `»»» workspace_name` | string | false | | | -| `»» organization_id` | string(uuid) | false | | | -| `»» queue_position` | integer | false | | | -| `»» queue_size` | integer | false | | | -| `»» started_at` | string(date-time) | false | | | -| `»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | | -| `»» tags` | object | false | | | -| `»»» [any property]` | string | false | | | -| `»» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | | -| `»» worker_id` | string(uuid) | false | | | -| `»» worker_name` | string | false | | | -| `» matched_provisioners` | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | false | | | -| `»» available` | integer | false | | Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped. | -| `»» count` | integer | false | | Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags. | -| `»» most_recently_seen` | string(date-time) | false | | Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null. | -| `» max_deadline` | string(date-time) | false | | | -| `» reason` | [codersdk.BuildReason](schemas.md#codersdkbuildreason) | false | | | -| `» resources` | array | false | | | -| `»» agents` | array | false | | | -| `»»» api_version` | string | false | | | -| `»»» apps` | array | false | | | -| `»»»» command` | string | false | | | -| `»»»» display_name` | string | false | | Display name is a friendly name for the app. | -| `»»»» external` | boolean | false | | External specifies whether the URL should be opened externally on the client or not. | -| `»»»» group` | string | false | | | -| `»»»» health` | [codersdk.WorkspaceAppHealth](schemas.md#codersdkworkspaceapphealth) | false | | | -| `»»»» healthcheck` | [codersdk.Healthcheck](schemas.md#codersdkhealthcheck) | false | | Healthcheck specifies the configuration for checking app health. | -| `»»»»» interval` | integer | false | | Interval specifies the seconds between each health check. | -| `»»»»» threshold` | integer | false | | Threshold specifies the number of consecutive failed health checks before returning "unhealthy". | -| `»»»»» url` | string | false | | URL specifies the endpoint to check for the app health. | -| `»»»» hidden` | boolean | false | | | -| `»»»» icon` | string | false | | Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. | -| `»»»» id` | string(uuid) | false | | | -| `»»»» open_in` | [codersdk.WorkspaceAppOpenIn](schemas.md#codersdkworkspaceappopenin) | false | | | -| `»»»» sharing_level` | [codersdk.WorkspaceAppSharingLevel](schemas.md#codersdkworkspaceappsharinglevel) | false | | | -| `»»»» slug` | string | false | | Slug is a unique identifier within the agent. | -| `»»»» statuses` | array | false | | Statuses is a list of statuses for the app. | -| `»»»»» agent_id` | string(uuid) | false | | | -| `»»»»» app_id` | string(uuid) | false | | | -| `»»»»» created_at` | string(date-time) | false | | | -| `»»»»» icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. | -| `»»»»» id` | string(uuid) | false | | | -| `»»»»» message` | string | false | | | -| `»»»»» needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. | -| `»»»»» state` | [codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate) | false | | | -| `»»»»» uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file | -| `»»»»» workspace_id` | string(uuid) | false | | | -| `»»»» subdomain` | boolean | false | | Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI. | -| `»»»» subdomain_name` | string | false | | Subdomain name is the application domain exposed on the `coder server`. | -| `»»»» url` | string | false | | URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client. | -| `»»» architecture` | string | false | | | -| `»»» connection_timeout_seconds` | integer | false | | | -| `»»» created_at` | string(date-time) | false | | | -| `»»» directory` | string | false | | | -| `»»» disconnected_at` | string(date-time) | false | | | -| `»»» display_apps` | array | false | | | -| `»»» environment_variables` | object | false | | | -| `»»»» [any property]` | string | false | | | -| `»»» expanded_directory` | string | false | | | -| `»»» first_connected_at` | string(date-time) | false | | | -| `»»» health` | [codersdk.WorkspaceAgentHealth](schemas.md#codersdkworkspaceagenthealth) | false | | Health reports the health of the agent. | -| `»»»» healthy` | boolean | false | | Healthy is true if the agent is healthy. | -| `»»»» reason` | string | false | | Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true. | -| `»»» id` | string(uuid) | false | | | -| `»»» instance_id` | string | false | | | -| `»»» last_connected_at` | string(date-time) | false | | | -| `»»» latency` | object | false | | Latency is mapped by region name (e.g. "New York City", "Seattle"). | -| `»»»» [any property]` | [codersdk.DERPRegion](schemas.md#codersdkderpregion) | false | | | -| `»»»»» latency_ms` | number | false | | | -| `»»»»» preferred` | boolean | false | | | -| `»»» lifecycle_state` | [codersdk.WorkspaceAgentLifecycle](schemas.md#codersdkworkspaceagentlifecycle) | false | | | -| `»»» log_sources` | array | false | | | -| `»»»» created_at` | string(date-time) | false | | | -| `»»»» display_name` | string | false | | | -| `»»»» icon` | string | false | | | -| `»»»» id` | string(uuid) | false | | | -| `»»»» workspace_agent_id` | string(uuid) | false | | | -| `»»» logs_length` | integer | false | | | -| `»»» logs_overflowed` | boolean | false | | | -| `»»» name` | string | false | | | -| `»»» operating_system` | string | false | | | -| `»»» parent_id` | [uuid.NullUUID](schemas.md#uuidnulluuid) | false | | | -| `»»»» uuid` | string | false | | | -| `»»»» valid` | boolean | false | | Valid is true if UUID is not NULL | -| `»»» ready_at` | string(date-time) | false | | | -| `»»» resource_id` | string(uuid) | false | | | -| `»»» scripts` | array | false | | | -| `»»»» cron` | string | false | | | -| `»»»» display_name` | string | false | | | -| `»»»» id` | string(uuid) | false | | | -| `»»»» log_path` | string | false | | | -| `»»»» log_source_id` | string(uuid) | false | | | -| `»»»» run_on_start` | boolean | false | | | -| `»»»» run_on_stop` | boolean | false | | | -| `»»»» script` | string | false | | | -| `»»»» start_blocks_login` | boolean | false | | | -| `»»»» timeout` | integer | false | | | -| `»»» started_at` | string(date-time) | false | | | -| `»»» startup_script_behavior` | [codersdk.WorkspaceAgentStartupScriptBehavior](schemas.md#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](schemas.md#codersdkworkspaceagentstatus) | false | | | -| `»»» subsystems` | array | false | | | -| `»»» troubleshooting_url` | string | false | | | -| `»»» updated_at` | string(date-time) | false | | | -| `»»» version` | string | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» daily_cost` | integer | false | | | -| `»» hide` | boolean | false | | | -| `»» icon` | string | false | | | -| `»» id` | string(uuid) | false | | | -| `»» job_id` | string(uuid) | false | | | -| `»» metadata` | array | false | | | -| `»»» key` | string | false | | | -| `»»» sensitive` | boolean | false | | | -| `»»» value` | string | false | | | -| `»» name` | string | false | | | -| `»» type` | string | false | | | -| `»» workspace_transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | | -| `» status` | [codersdk.WorkspaceStatus](schemas.md#codersdkworkspacestatus) | false | | | -| `» template_version_id` | string(uuid) | false | | | -| `» template_version_name` | string | false | | | -| `» template_version_preset_id` | string(uuid) | false | | | -| `» transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | | -| `» updated_at` | string(date-time) | false | | | -| `» workspace_id` | string(uuid) | false | | | -| `» workspace_name` | string | false | | | -| `» workspace_owner_avatar_url` | string | false | | | -| `» workspace_owner_id` | string(uuid) | false | | | -| `» workspace_owner_name` | string | false | | Workspace owner name is the username of the owner of the workspace. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» ai_task_sidebar_app_id`|string(uuid)|false||| +|`» build_number`|integer|false||| +|`» created_at`|string(date-time)|false||| +|`» daily_cost`|integer|false||| +|`» deadline`|string(date-time)|false||| +|`» has_ai_task`|boolean|false||| +|`» id`|string(uuid)|false||| +|`» initiator_id`|string(uuid)|false||| +|`» initiator_name`|string|false||| +|`» job`|[codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob)|false||| +|`»» available_workers`|array|false||| +|`»» canceled_at`|string(date-time)|false||| +|`»» completed_at`|string(date-time)|false||| +|`»» created_at`|string(date-time)|false||| +|`»» error`|string|false||| +|`»» error_code`|[codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode)|false||| +|`»» file_id`|string(uuid)|false||| +|`»» id`|string(uuid)|false||| +|`»» input`|[codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput)|false||| +|`»»» error`|string|false||| +|`»»» template_version_id`|string(uuid)|false||| +|`»»» workspace_build_id`|string(uuid)|false||| +|`»» metadata`|[codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata)|false||| +|`»»» template_display_name`|string|false||| +|`»»» template_icon`|string|false||| +|`»»» template_id`|string(uuid)|false||| +|`»»» template_name`|string|false||| +|`»»» template_version_name`|string|false||| +|`»»» workspace_id`|string(uuid)|false||| +|`»»» workspace_name`|string|false||| +|`»» organization_id`|string(uuid)|false||| +|`»» queue_position`|integer|false||| +|`»» queue_size`|integer|false||| +|`»» started_at`|string(date-time)|false||| +|`»» status`|[codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus)|false||| +|`»» tags`|object|false||| +|`»»» [any property]`|string|false||| +|`»» type`|[codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype)|false||| +|`»» worker_id`|string(uuid)|false||| +|`»» worker_name`|string|false||| +|`» matched_provisioners`|[codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners)|false||| +|`»» available`|integer|false||Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped.| +|`»» count`|integer|false||Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags.| +|`»» most_recently_seen`|string(date-time)|false||Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null.| +|`» max_deadline`|string(date-time)|false||| +|`» reason`|[codersdk.BuildReason](schemas.md#codersdkbuildreason)|false||| +|`» resources`|array|false||| +|`»» agents`|array|false||| +|`»»» api_version`|string|false||| +|`»»» apps`|array|false||| +|`»»»» command`|string|false||| +|`»»»» display_name`|string|false||Display name is a friendly name for the app.| +|`»»»» external`|boolean|false||External specifies whether the URL should be opened externally on the client or not.| +|`»»»» group`|string|false||| +|`»»»» health`|[codersdk.WorkspaceAppHealth](schemas.md#codersdkworkspaceapphealth)|false||| +|`»»»» healthcheck`|[codersdk.Healthcheck](schemas.md#codersdkhealthcheck)|false||Healthcheck specifies the configuration for checking app health.| +|`»»»»» interval`|integer|false||Interval specifies the seconds between each health check.| +|`»»»»» threshold`|integer|false||Threshold specifies the number of consecutive failed health checks before returning "unhealthy".| +|`»»»»» url`|string|false||URL specifies the endpoint to check for the app health.| +|`»»»» hidden`|boolean|false||| +|`»»»» icon`|string|false||Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.| +|`»»»» id`|string(uuid)|false||| +|`»»»» open_in`|[codersdk.WorkspaceAppOpenIn](schemas.md#codersdkworkspaceappopenin)|false||| +|`»»»» sharing_level`|[codersdk.WorkspaceAppSharingLevel](schemas.md#codersdkworkspaceappsharinglevel)|false||| +|`»»»» slug`|string|false||Slug is a unique identifier within the agent.| +|`»»»» statuses`|array|false||Statuses is a list of statuses for the app.| +|`»»»»» agent_id`|string(uuid)|false||| +|`»»»»» app_id`|string(uuid)|false||| +|`»»»»» created_at`|string(date-time)|false||| +|`»»»»» icon`|string|false||Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI.| +|`»»»»» id`|string(uuid)|false||| +|`»»»»» message`|string|false||| +|`»»»»» needs_user_attention`|boolean|false||Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention.| +|`»»»»» state`|[codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate)|false||| +|`»»»»» uri`|string|false||Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file| +|`»»»»» workspace_id`|string(uuid)|false||| +|`»»»» subdomain`|boolean|false||Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.| +|`»»»» subdomain_name`|string|false||Subdomain name is the application domain exposed on the `coder server`.| +|`»»»» url`|string|false||URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.| +|`»»» architecture`|string|false||| +|`»»» connection_timeout_seconds`|integer|false||| +|`»»» created_at`|string(date-time)|false||| +|`»»» directory`|string|false||| +|`»»» disconnected_at`|string(date-time)|false||| +|`»»» display_apps`|array|false||| +|`»»» environment_variables`|object|false||| +|`»»»» [any property]`|string|false||| +|`»»» expanded_directory`|string|false||| +|`»»» first_connected_at`|string(date-time)|false||| +|`»»» health`|[codersdk.WorkspaceAgentHealth](schemas.md#codersdkworkspaceagenthealth)|false||Health reports the health of the agent.| +|`»»»» healthy`|boolean|false||Healthy is true if the agent is healthy.| +|`»»»» reason`|string|false||Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.| +|`»»» id`|string(uuid)|false||| +|`»»» instance_id`|string|false||| +|`»»» last_connected_at`|string(date-time)|false||| +|`»»» latency`|object|false||Latency is mapped by region name (e.g. "New York City", "Seattle").| +|`»»»» [any property]`|[codersdk.DERPRegion](schemas.md#codersdkderpregion)|false||| +|`»»»»» latency_ms`|number|false||| +|`»»»»» preferred`|boolean|false||| +|`»»» lifecycle_state`|[codersdk.WorkspaceAgentLifecycle](schemas.md#codersdkworkspaceagentlifecycle)|false||| +|`»»» log_sources`|array|false||| +|`»»»» created_at`|string(date-time)|false||| +|`»»»» display_name`|string|false||| +|`»»»» icon`|string|false||| +|`»»»» id`|string(uuid)|false||| +|`»»»» workspace_agent_id`|string(uuid)|false||| +|`»»» logs_length`|integer|false||| +|`»»» logs_overflowed`|boolean|false||| +|`»»» name`|string|false||| +|`»»» operating_system`|string|false||| +|`»»» parent_id`|[uuid.NullUUID](schemas.md#uuidnulluuid)|false||| +|`»»»» uuid`|string|false||| +|`»»»» valid`|boolean|false||Valid is true if UUID is not NULL| +|`»»» ready_at`|string(date-time)|false||| +|`»»» resource_id`|string(uuid)|false||| +|`»»» scripts`|array|false||| +|`»»»» cron`|string|false||| +|`»»»» display_name`|string|false||| +|`»»»» id`|string(uuid)|false||| +|`»»»» log_path`|string|false||| +|`»»»» log_source_id`|string(uuid)|false||| +|`»»»» run_on_start`|boolean|false||| +|`»»»» run_on_stop`|boolean|false||| +|`»»»» script`|string|false||| +|`»»»» start_blocks_login`|boolean|false||| +|`»»»» timeout`|integer|false||| +|`»»» started_at`|string(date-time)|false||| +|`»»» startup_script_behavior`|[codersdk.WorkspaceAgentStartupScriptBehavior](schemas.md#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](schemas.md#codersdkworkspaceagentstatus)|false||| +|`»»» subsystems`|array|false||| +|`»»» troubleshooting_url`|string|false||| +|`»»» updated_at`|string(date-time)|false||| +|`»»» version`|string|false||| +|`»» created_at`|string(date-time)|false||| +|`»» daily_cost`|integer|false||| +|`»» hide`|boolean|false||| +|`»» icon`|string|false||| +|`»» id`|string(uuid)|false||| +|`»» job_id`|string(uuid)|false||| +|`»» metadata`|array|false||| +|`»»» key`|string|false||| +|`»»» sensitive`|boolean|false||| +|`»»» value`|string|false||| +|`»» name`|string|false||| +|`»» type`|string|false||| +|`»» workspace_transition`|[codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition)|false||| +|`» status`|[codersdk.WorkspaceStatus](schemas.md#codersdkworkspacestatus)|false||| +|`» template_version_id`|string(uuid)|false||| +|`» template_version_name`|string|false||| +|`» template_version_preset_id`|string(uuid)|false||| +|`» transition`|[codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition)|false||| +|`» updated_at`|string(date-time)|false||| +|`» workspace_id`|string(uuid)|false||| +|`» workspace_name`|string|false||| +|`» workspace_owner_avatar_url`|string|false||| +|`» workspace_owner_id`|string(uuid)|false||| +|`» workspace_owner_name`|string|false||Workspace owner name is the username of the owner of the workspace.| #### Enumerated Values -| Property | Value | -|---------------------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `type` | `template_version_import` | -| `type` | `workspace_build` | -| `type` | `template_version_dry_run` | -| `reason` | `initiator` | -| `reason` | `autostart` | -| `reason` | `autostop` | -| `health` | `disabled` | -| `health` | `initializing` | -| `health` | `healthy` | -| `health` | `unhealthy` | -| `open_in` | `slim-window` | -| `open_in` | `tab` | -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | -| `state` | `working` | -| `state` | `idle` | -| `state` | `complete` | -| `state` | `failure` | -| `lifecycle_state` | `created` | -| `lifecycle_state` | `starting` | -| `lifecycle_state` | `start_timeout` | -| `lifecycle_state` | `start_error` | -| `lifecycle_state` | `ready` | -| `lifecycle_state` | `shutting_down` | -| `lifecycle_state` | `shutdown_timeout` | -| `lifecycle_state` | `shutdown_error` | -| `lifecycle_state` | `off` | -| `startup_script_behavior` | `blocking` | -| `startup_script_behavior` | `non-blocking` | -| `status` | `connecting` | -| `status` | `connected` | -| `status` | `disconnected` | -| `status` | `timeout` | -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | -| `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` | +|Property|Value| +|---|---| +|`error_code`|`REQUIRED_TEMPLATE_VARIABLES`| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| +|`type`|`template_version_import`| +|`type`|`workspace_build`| +|`type`|`template_version_dry_run`| +|`reason`|`initiator`| +|`reason`|`autostart`| +|`reason`|`autostop`| +|`health`|`disabled`| +|`health`|`initializing`| +|`health`|`healthy`| +|`health`|`unhealthy`| +|`open_in`|`slim-window`| +|`open_in`|`tab`| +|`sharing_level`|`owner`| +|`sharing_level`|`authenticated`| +|`sharing_level`|`organization`| +|`sharing_level`|`public`| +|`state`|`working`| +|`state`|`idle`| +|`state`|`complete`| +|`state`|`failure`| +|`lifecycle_state`|`created`| +|`lifecycle_state`|`starting`| +|`lifecycle_state`|`start_timeout`| +|`lifecycle_state`|`start_error`| +|`lifecycle_state`|`ready`| +|`lifecycle_state`|`shutting_down`| +|`lifecycle_state`|`shutdown_timeout`| +|`lifecycle_state`|`shutdown_error`| +|`lifecycle_state`|`off`| +|`startup_script_behavior`|`blocking`| +|`startup_script_behavior`|`non-blocking`| +|`status`|`connecting`| +|`status`|`connected`| +|`status`|`disconnected`| +|`status`|`timeout`| +|`workspace_transition`|`start`| +|`workspace_transition`|`stop`| +|`workspace_transition`|`delete`| +|`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`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1780,10 +1780,10 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|----------------------------------------------------------------------------------------|----------|--------------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.CreateWorkspaceBuildRequest](schemas.md#codersdkcreateworkspacebuildrequest) | true | Create workspace build request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.CreateWorkspaceBuildRequest](schemas.md#codersdkcreateworkspacebuildrequest)|true|Create workspace build request| ### Example responses @@ -1997,8 +1997,8 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/debug.md b/docs/reference/api/debug.md index 93fd3e7b638c2..1de16ad0bf90e 100644 --- a/docs/reference/api/debug.md +++ b/docs/reference/api/debug.md @@ -14,9 +14,9 @@ curl -X GET http://coder-server:8080/api/v2/debug/coordinator \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -35,9 +35,9 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \ ### Parameters -| Name | In | Type | Required | Description | -|---------|-------|---------|----------|----------------------------| -| `force` | query | boolean | false | Force a healthcheck to run | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`force`|query|boolean|false|Force a healthcheck to run| ### Example responses @@ -417,9 +417,9 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.HealthcheckReport](schemas.md#healthsdkhealthcheckreport) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[healthsdk.HealthcheckReport](schemas.md#healthsdkhealthcheckreport)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -450,9 +450,9 @@ curl -X GET http://coder-server:8080/api/v2/debug/health/settings \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.HealthSettings](schemas.md#healthsdkhealthsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[healthsdk.HealthSettings](schemas.md#healthsdkhealthsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -482,9 +482,9 @@ curl -X PUT http://coder-server:8080/api/v2/debug/health/settings \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------|----------|------------------------| -| `body` | body | [healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings) | true | Update health settings | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings)|true|Update health settings| ### Example responses @@ -500,9 +500,9 @@ curl -X PUT http://coder-server:8080/api/v2/debug/health/settings \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -520,8 +520,8 @@ curl -X GET http://coder-server:8080/api/v2/debug/tailnet \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/enterprise.md b/docs/reference/api/enterprise.md index c9b65a97d2f03..e43913e3ab05c 100644 --- a/docs/reference/api/enterprise.md +++ b/docs/reference/api/enterprise.md @@ -42,9 +42,9 @@ curl -X GET http://coder-server:8080/api/v2/.well-known/oauth-authorization-serv ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OAuth2AuthorizationServerMetadata](schemas.md#codersdkoauth2authorizationservermetadata) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OAuth2AuthorizationServerMetadata](schemas.md#codersdkoauth2authorizationservermetadata)| ## OAuth2 protected resource metadata @@ -79,9 +79,9 @@ curl -X GET http://coder-server:8080/api/v2/.well-known/oauth-protected-resource ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OAuth2ProtectedResourceMetadata](schemas.md#codersdkoauth2protectedresourcemetadata) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OAuth2ProtectedResourceMetadata](schemas.md#codersdkoauth2protectedresourcemetadata)| ## Get appearance @@ -129,9 +129,9 @@ curl -X GET http://coder-server:8080/api/v2/appearance \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AppearanceConfig](schemas.md#codersdkappearanceconfig) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.AppearanceConfig](schemas.md#codersdkappearanceconfig)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -172,9 +172,9 @@ curl -X PUT http://coder-server:8080/api/v2/appearance \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------|----------|---------------------------| -| `body` | body | [codersdk.UpdateAppearanceConfig](schemas.md#codersdkupdateappearanceconfig) | true | Update appearance request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.UpdateAppearanceConfig](schemas.md#codersdkupdateappearanceconfig)|true|Update appearance request| ### Example responses @@ -201,9 +201,9 @@ curl -X PUT http://coder-server:8080/api/v2/appearance \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UpdateAppearanceConfig](schemas.md#codersdkupdateappearanceconfig) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.UpdateAppearanceConfig](schemas.md#codersdkupdateappearanceconfig)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -222,11 +222,11 @@ curl -X GET http://coder-server:8080/api/v2/connectionlog?limit=0 \ ### Parameters -| Name | In | Type | Required | Description | -|----------|-------|---------|----------|--------------| -| `q` | query | string | false | Search query | -| `limit` | query | integer | true | Page limit | -| `offset` | query | integer | false | Page offset | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`q`|query|string|false|Search query| +|`limit`|query|integer|true|Page limit| +|`offset`|query|integer|false|Page offset| ### Example responses @@ -293,9 +293,9 @@ curl -X GET http://coder-server:8080/api/v2/connectionlog?limit=0 \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ConnectionLogResponse](schemas.md#codersdkconnectionlogresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ConnectionLogResponse](schemas.md#codersdkconnectionlogresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -359,9 +359,9 @@ curl -X GET http://coder-server:8080/api/v2/entitlements \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Entitlements](schemas.md#codersdkentitlements) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Entitlements](schemas.md#codersdkentitlements)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -380,11 +380,11 @@ curl -X GET http://coder-server:8080/api/v2/groups?organization=string&has_membe ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|--------|----------|-----------------------------------| -| `organization` | query | string | true | Organization ID or name | -| `has_member` | query | string | true | User ID or name | -| `group_ids` | query | string | true | Comma separated list of group IDs | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|query|string|true|Organization ID or name| +|`has_member`|query|string|true|User ID or name| +|`group_ids`|query|string|true|Comma separated list of group IDs| ### Example responses @@ -424,54 +424,54 @@ curl -X GET http://coder-server:8080/api/v2/groups?organization=string&has_membe ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Group](schemas.md#codersdkgroup) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Group](schemas.md#codersdkgroup)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-------------------------------|--------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» avatar_url` | string(uri) | false | | | -| `» display_name` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» members` | array | false | | | -| `»» avatar_url` | string(uri) | false | | | -| `»» created_at` | string(date-time) | true | | | -| `»» email` | string(email) | true | | | -| `»» id` | string(uuid) | true | | | -| `»» last_seen_at` | string(date-time) | false | | | -| `»» login_type` | [codersdk.LoginType](schemas.md#codersdklogintype) | false | | | -| `»» name` | string | false | | | -| `»» status` | [codersdk.UserStatus](schemas.md#codersdkuserstatus) | false | | | -| `»» theme_preference` | string | false | | Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead. | -| `»» updated_at` | string(date-time) | false | | | -| `»» username` | string | true | | | -| `» name` | string | false | | | -| `» organization_display_name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» organization_name` | string | false | | | -| `» quota_allowance` | integer | false | | | -| `» source` | [codersdk.GroupSource](schemas.md#codersdkgroupsource) | false | | | -| `» total_member_count` | integer | false | | How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» avatar_url`|string(uri)|false||| +|`» display_name`|string|false||| +|`» id`|string(uuid)|false||| +|`» members`|array|false||| +|`»» avatar_url`|string(uri)|false||| +|`»» created_at`|string(date-time)|true||| +|`»» email`|string(email)|true||| +|`»» id`|string(uuid)|true||| +|`»» last_seen_at`|string(date-time)|false||| +|`»» login_type`|[codersdk.LoginType](schemas.md#codersdklogintype)|false||| +|`»» name`|string|false||| +|`»» status`|[codersdk.UserStatus](schemas.md#codersdkuserstatus)|false||| +|`»» theme_preference`|string|false||Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead.| +|`»» updated_at`|string(date-time)|false||| +|`»» username`|string|true||| +|`» name`|string|false||| +|`» organization_display_name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» organization_name`|string|false||| +|`» quota_allowance`|integer|false||| +|`» source`|[codersdk.GroupSource](schemas.md#codersdkgroupsource)|false||| +|`» total_member_count`|integer|false||How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`.| #### Enumerated Values -| Property | Value | -|--------------|-------------| -| `login_type` | `` | -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `login_type` | `none` | -| `status` | `active` | -| `status` | `suspended` | -| `source` | `user` | -| `source` | `oidc` | +|Property|Value| +|---|---| +|`login_type`|``| +|`login_type`|`password`| +|`login_type`|`github`| +|`login_type`|`oidc`| +|`login_type`|`token`| +|`login_type`|`none`| +|`status`|`active`| +|`status`|`suspended`| +|`source`|`user`| +|`source`|`oidc`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -490,9 +490,9 @@ curl -X GET http://coder-server:8080/api/v2/groups/{group} \ ### Parameters -| Name | In | Type | Required | Description | -|---------|------|--------|----------|-------------| -| `group` | path | string | true | Group id | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`group`|path|string|true|Group id| ### Example responses @@ -530,9 +530,9 @@ curl -X GET http://coder-server:8080/api/v2/groups/{group} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Group](schemas.md#codersdkgroup) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Group](schemas.md#codersdkgroup)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -551,9 +551,9 @@ curl -X DELETE http://coder-server:8080/api/v2/groups/{group} \ ### Parameters -| Name | In | Type | Required | Description | -|---------|------|--------|----------|-------------| -| `group` | path | string | true | Group name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`group`|path|string|true|Group name| ### Example responses @@ -591,9 +591,9 @@ curl -X DELETE http://coder-server:8080/api/v2/groups/{group} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Group](schemas.md#codersdkgroup) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Group](schemas.md#codersdkgroup)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -630,10 +630,10 @@ curl -X PATCH http://coder-server:8080/api/v2/groups/{group} \ ### Parameters -| Name | In | Type | Required | Description | -|---------|------|--------------------------------------------------------------------|----------|---------------------| -| `group` | path | string | true | Group name | -| `body` | body | [codersdk.PatchGroupRequest](schemas.md#codersdkpatchgrouprequest) | true | Patch group request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`group`|path|string|true|Group name| +|`body`|body|[codersdk.PatchGroupRequest](schemas.md#codersdkpatchgrouprequest)|true|Patch group request| ### Example responses @@ -671,9 +671,9 @@ curl -X PATCH http://coder-server:8080/api/v2/groups/{group} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Group](schemas.md#codersdkgroup) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Group](schemas.md#codersdkgroup)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -707,21 +707,21 @@ curl -X GET http://coder-server:8080/api/v2/licenses \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.License](schemas.md#codersdklicense) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.License](schemas.md#codersdklicense)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-----------------|-------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» 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(date-time) | false | | | -| `» uuid` | string(uuid) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» 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(date-time)|false||| +|`» uuid`|string(uuid)|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -739,15 +739,15 @@ curl -X DELETE http://coder-server:8080/api/v2/licenses/{id} \ ### Parameters -| Name | In | Type | Required | Description | -|------|------|----------------|----------|-------------| -| `id` | path | string(number) | true | License ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`id`|path|string(number)|true|License ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -765,16 +765,16 @@ curl -X PUT http://coder-server:8080/api/v2/notifications/templates/{notificatio ### Parameters -| Name | In | Type | Required | Description | -|-------------------------|------|--------|----------|----------------------------| -| `notification_template` | path | string | true | Notification template UUID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`notification_template`|path|string|true|Notification template UUID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|--------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | | -| 304 | [Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1) | Not modified | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|| +|304|[Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1)|Not modified|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -793,9 +793,9 @@ curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps \ ### Parameters -| Name | In | Type | Required | Description | -|-----------|-------|--------|----------|----------------------------------------------| -| `user_id` | query | string | false | Filter by applications authorized for a user | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user_id`|query|string|false|Filter by applications authorized for a user| ### Example responses @@ -819,25 +819,25 @@ curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.OAuth2ProviderApp](schemas.md#codersdkoauth2providerapp) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.OAuth2ProviderApp](schemas.md#codersdkoauth2providerapp)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|---------------------------|----------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» callback_url` | string | false | | | -| `» endpoints` | [codersdk.OAuth2AppEndpoints](schemas.md#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). | -| `»» authorization` | string | false | | | -| `»» device_authorization` | string | false | | Device authorization is optional. | -| `»» token` | string | false | | | -| `» icon` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» callback_url`|string|false||| +|`» endpoints`|[codersdk.OAuth2AppEndpoints](schemas.md#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).| +|`»» authorization`|string|false||| +|`»» device_authorization`|string|false||Device authorization is optional.| +|`»» token`|string|false||| +|`» icon`|string|false||| +|`» id`|string(uuid)|false||| +|`» name`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -867,9 +867,9 @@ curl -X POST http://coder-server:8080/api/v2/oauth2-provider/apps \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------------------|----------|-----------------------------------| -| `body` | body | [codersdk.PostOAuth2ProviderAppRequest](schemas.md#codersdkpostoauth2providerapprequest) | true | The OAuth2 application to create. | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.PostOAuth2ProviderAppRequest](schemas.md#codersdkpostoauth2providerapprequest)|true|The OAuth2 application to create.| ### Example responses @@ -891,9 +891,9 @@ curl -X POST http://coder-server:8080/api/v2/oauth2-provider/apps \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OAuth2ProviderApp](schemas.md#codersdkoauth2providerapp) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OAuth2ProviderApp](schemas.md#codersdkoauth2providerapp)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -912,9 +912,9 @@ curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps/{app} \ ### Parameters -| Name | In | Type | Required | Description | -|-------|------|--------|----------|-------------| -| `app` | path | string | true | App ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`app`|path|string|true|App ID| ### Example responses @@ -936,9 +936,9 @@ curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps/{app} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OAuth2ProviderApp](schemas.md#codersdkoauth2providerapp) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OAuth2ProviderApp](schemas.md#codersdkoauth2providerapp)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -968,10 +968,10 @@ curl -X PUT http://coder-server:8080/api/v2/oauth2-provider/apps/{app} \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------------|----------|-------------------------------| -| `app` | path | string | true | App ID | -| `body` | body | [codersdk.PutOAuth2ProviderAppRequest](schemas.md#codersdkputoauth2providerapprequest) | true | Update an OAuth2 application. | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`app`|path|string|true|App ID| +|`body`|body|[codersdk.PutOAuth2ProviderAppRequest](schemas.md#codersdkputoauth2providerapprequest)|true|Update an OAuth2 application.| ### Example responses @@ -993,9 +993,9 @@ curl -X PUT http://coder-server:8080/api/v2/oauth2-provider/apps/{app} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OAuth2ProviderApp](schemas.md#codersdkoauth2providerapp) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OAuth2ProviderApp](schemas.md#codersdkoauth2providerapp)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1013,15 +1013,15 @@ curl -X DELETE http://coder-server:8080/api/v2/oauth2-provider/apps/{app} \ ### Parameters -| Name | In | Type | Required | Description | -|-------|------|--------|----------|-------------| -| `app` | path | string | true | App ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`app`|path|string|true|App ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1040,9 +1040,9 @@ curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps/{app}/secrets \ ### Parameters -| Name | In | Type | Required | Description | -|-------|------|--------|----------|-------------| -| `app` | path | string | true | App ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`app`|path|string|true|App ID| ### Example responses @@ -1060,20 +1060,20 @@ curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps/{app}/secrets \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.OAuth2ProviderAppSecret](schemas.md#codersdkoauth2providerappsecret) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.OAuth2ProviderAppSecret](schemas.md#codersdkoauth2providerappsecret)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-----------------------------|--------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» client_secret_truncated` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» last_used_at` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» client_secret_truncated`|string|false||| +|`» id`|string(uuid)|false||| +|`» last_used_at`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1092,9 +1092,9 @@ curl -X POST http://coder-server:8080/api/v2/oauth2-provider/apps/{app}/secrets ### Parameters -| Name | In | Type | Required | Description | -|-------|------|--------|----------|-------------| -| `app` | path | string | true | App ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`app`|path|string|true|App ID| ### Example responses @@ -1111,19 +1111,19 @@ curl -X POST http://coder-server:8080/api/v2/oauth2-provider/apps/{app}/secrets ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.OAuth2ProviderAppSecretFull](schemas.md#codersdkoauth2providerappsecretfull) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.OAuth2ProviderAppSecretFull](schemas.md#codersdkoauth2providerappsecretfull)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------------|--------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» client_secret_full` | string | false | | | -| `» id` | string(uuid) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» client_secret_full`|string|false||| +|`» id`|string(uuid)|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1141,16 +1141,16 @@ curl -X DELETE http://coder-server:8080/api/v2/oauth2-provider/apps/{app}/secret ### Parameters -| Name | In | Type | Required | Description | -|------------|------|--------|----------|-------------| -| `app` | path | string | true | App ID | -| `secretID` | path | string | true | Secret ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`app`|path|string|true|App ID| +|`secretID`|path|string|true|Secret ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1168,25 +1168,25 @@ curl -X GET http://coder-server:8080/api/v2/oauth2/authorize?client_id=string&st ### Parameters -| Name | In | Type | Required | Description | -|-----------------|-------|--------|----------|-----------------------------------| -| `client_id` | query | string | true | Client ID | -| `state` | query | string | true | A random unguessable string | -| `response_type` | query | string | true | Response type | -| `redirect_uri` | query | string | false | Redirect here after authorization | -| `scope` | query | string | false | Token scopes (currently ignored) | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`client_id`|query|string|true|Client ID| +|`state`|query|string|true|A random unguessable string| +|`response_type`|query|string|true|Response type| +|`redirect_uri`|query|string|false|Redirect here after authorization| +|`scope`|query|string|false|Token scopes (currently ignored)| #### Enumerated Values -| Parameter | Value | -|-----------------|--------| -| `response_type` | `code` | +|Parameter|Value| +|---|---| +|`response_type`|`code`| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|---------------------------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Returns HTML authorization page | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns HTML authorization page|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1204,25 +1204,25 @@ curl -X POST http://coder-server:8080/api/v2/oauth2/authorize?client_id=string&s ### Parameters -| Name | In | Type | Required | Description | -|-----------------|-------|--------|----------|-----------------------------------| -| `client_id` | query | string | true | Client ID | -| `state` | query | string | true | A random unguessable string | -| `response_type` | query | string | true | Response type | -| `redirect_uri` | query | string | false | Redirect here after authorization | -| `scope` | query | string | false | Token scopes (currently ignored) | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`client_id`|query|string|true|Client ID| +|`state`|query|string|true|A random unguessable string| +|`response_type`|query|string|true|Response type| +|`redirect_uri`|query|string|false|Redirect here after authorization| +|`scope`|query|string|false|Token scopes (currently ignored)| #### Enumerated Values -| Parameter | Value | -|-----------------|--------| -| `response_type` | `code` | +|Parameter|Value| +|---|---| +|`response_type`|`code`| ### Responses -| Status | Meaning | Description | Schema | -|--------|------------------------------------------------------------|------------------------------------------|--------| -| 302 | [Found](https://tools.ietf.org/html/rfc7231#section-6.4.3) | Returns redirect with authorization code | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|302|[Found](https://tools.ietf.org/html/rfc7231#section-6.4.3)|Returns redirect with authorization code|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1240,9 +1240,9 @@ curl -X GET http://coder-server:8080/api/v2/oauth2/clients/{client_id} \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------|----------|-------------| -| `client_id` | path | string | true | Client ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`client_id`|path|string|true|Client ID| ### Example responses @@ -1283,9 +1283,9 @@ curl -X GET http://coder-server:8080/api/v2/oauth2/clients/{client_id} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OAuth2ClientConfiguration](schemas.md#codersdkoauth2clientconfiguration) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OAuth2ClientConfiguration](schemas.md#codersdkoauth2clientconfiguration)| ## Update OAuth2 client configuration (RFC 7592) @@ -1333,10 +1333,10 @@ curl -X PUT http://coder-server:8080/api/v2/oauth2/clients/{client_id} \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|------------------------------------------------------------------------------------------------|----------|-----------------------| -| `client_id` | path | string | true | Client ID | -| `body` | body | [codersdk.OAuth2ClientRegistrationRequest](schemas.md#codersdkoauth2clientregistrationrequest) | true | Client update request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`client_id`|path|string|true|Client ID| +|`body`|body|[codersdk.OAuth2ClientRegistrationRequest](schemas.md#codersdkoauth2clientregistrationrequest)|true|Client update request| ### Example responses @@ -1377,9 +1377,9 @@ curl -X PUT http://coder-server:8080/api/v2/oauth2/clients/{client_id} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OAuth2ClientConfiguration](schemas.md#codersdkoauth2clientconfiguration) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OAuth2ClientConfiguration](schemas.md#codersdkoauth2clientconfiguration)| ## Delete OAuth2 client registration (RFC 7592) @@ -1395,15 +1395,15 @@ curl -X DELETE http://coder-server:8080/api/v2/oauth2/clients/{client_id} ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------|----------|-------------| -| `client_id` | path | string | true | Client ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`client_id`|path|string|true|Client ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| ## OAuth2 dynamic client registration (RFC 7591) @@ -1451,9 +1451,9 @@ curl -X POST http://coder-server:8080/api/v2/oauth2/register \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------------------------|----------|-----------------------------| -| `body` | body | [codersdk.OAuth2ClientRegistrationRequest](schemas.md#codersdkoauth2clientregistrationrequest) | true | Client registration request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.OAuth2ClientRegistrationRequest](schemas.md#codersdkoauth2clientregistrationrequest)|true|Client registration request| ### Example responses @@ -1495,9 +1495,9 @@ curl -X POST http://coder-server:8080/api/v2/oauth2/register \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.OAuth2ClientRegistrationResponse](schemas.md#codersdkoauth2clientregistrationresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.OAuth2ClientRegistrationResponse](schemas.md#codersdkoauth2clientregistrationresponse)| ## OAuth2 token exchange @@ -1524,21 +1524,21 @@ grant_type: authorization_code ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------|----------|---------------------------------------------------------------| -| `body` | body | object | false | | -| `» client_id` | body | string | false | Client ID, required if grant_type=authorization_code | -| `» client_secret` | body | string | false | Client secret, required if grant_type=authorization_code | -| `» code` | body | string | false | Authorization code, required if grant_type=authorization_code | -| `» refresh_token` | body | string | false | Refresh token, required if grant_type=refresh_token | -| `» grant_type` | body | string | true | Grant type | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|object|false|| +|`» client_id`|body|string|false|Client ID, required if grant_type=authorization_code| +|`» client_secret`|body|string|false|Client secret, required if grant_type=authorization_code| +|`» code`|body|string|false|Authorization code, required if grant_type=authorization_code| +|`» refresh_token`|body|string|false|Refresh token, required if grant_type=refresh_token| +|`» grant_type`|body|string|true|Grant type| #### Enumerated Values -| Parameter | Value | -|----------------|----------------------| -| `» grant_type` | `authorization_code` | -| `» grant_type` | `refresh_token` | +|Parameter|Value| +|---|---| +|`» grant_type`|`authorization_code`| +|`» grant_type`|`refresh_token`| ### Example responses @@ -1556,9 +1556,9 @@ grant_type: authorization_code ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [oauth2.Token](schemas.md#oauth2token) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[oauth2.Token](schemas.md#oauth2token)| ## Delete OAuth2 application tokens @@ -1574,15 +1574,15 @@ curl -X DELETE http://coder-server:8080/api/v2/oauth2/tokens?client_id=string \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|-------|--------|----------|-------------| -| `client_id` | query | string | true | Client ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`client_id`|query|string|true|Client ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1601,9 +1601,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/groups ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -1643,54 +1643,54 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/groups ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Group](schemas.md#codersdkgroup) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Group](schemas.md#codersdkgroup)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-------------------------------|--------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» avatar_url` | string(uri) | false | | | -| `» display_name` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» members` | array | false | | | -| `»» avatar_url` | string(uri) | false | | | -| `»» created_at` | string(date-time) | true | | | -| `»» email` | string(email) | true | | | -| `»» id` | string(uuid) | true | | | -| `»» last_seen_at` | string(date-time) | false | | | -| `»» login_type` | [codersdk.LoginType](schemas.md#codersdklogintype) | false | | | -| `»» name` | string | false | | | -| `»» status` | [codersdk.UserStatus](schemas.md#codersdkuserstatus) | false | | | -| `»» theme_preference` | string | false | | Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead. | -| `»» updated_at` | string(date-time) | false | | | -| `»» username` | string | true | | | -| `» name` | string | false | | | -| `» organization_display_name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» organization_name` | string | false | | | -| `» quota_allowance` | integer | false | | | -| `» source` | [codersdk.GroupSource](schemas.md#codersdkgroupsource) | false | | | -| `» total_member_count` | integer | false | | How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» avatar_url`|string(uri)|false||| +|`» display_name`|string|false||| +|`» id`|string(uuid)|false||| +|`» members`|array|false||| +|`»» avatar_url`|string(uri)|false||| +|`»» created_at`|string(date-time)|true||| +|`»» email`|string(email)|true||| +|`»» id`|string(uuid)|true||| +|`»» last_seen_at`|string(date-time)|false||| +|`»» login_type`|[codersdk.LoginType](schemas.md#codersdklogintype)|false||| +|`»» name`|string|false||| +|`»» status`|[codersdk.UserStatus](schemas.md#codersdkuserstatus)|false||| +|`»» theme_preference`|string|false||Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead.| +|`»» updated_at`|string(date-time)|false||| +|`»» username`|string|true||| +|`» name`|string|false||| +|`» organization_display_name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» organization_name`|string|false||| +|`» quota_allowance`|integer|false||| +|`» source`|[codersdk.GroupSource](schemas.md#codersdkgroupsource)|false||| +|`» total_member_count`|integer|false||How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`.| #### Enumerated Values -| Property | Value | -|--------------|-------------| -| `login_type` | `` | -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `login_type` | `none` | -| `status` | `active` | -| `status` | `suspended` | -| `source` | `user` | -| `source` | `oidc` | +|Property|Value| +|---|---| +|`login_type`|``| +|`login_type`|`password`| +|`login_type`|`github`| +|`login_type`|`oidc`| +|`login_type`|`token`| +|`login_type`|`none`| +|`status`|`active`| +|`status`|`suspended`| +|`source`|`user`| +|`source`|`oidc`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1721,10 +1721,10 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/groups ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|----------------------------------------------------------------------|----------|----------------------| -| `organization` | path | string | true | Organization ID | -| `body` | body | [codersdk.CreateGroupRequest](schemas.md#codersdkcreategrouprequest) | true | Create group request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| +|`body`|body|[codersdk.CreateGroupRequest](schemas.md#codersdkcreategrouprequest)|true|Create group request| ### Example responses @@ -1762,9 +1762,9 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/groups ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|--------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Group](schemas.md#codersdkgroup) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.Group](schemas.md#codersdkgroup)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1783,10 +1783,10 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/groups/ ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `groupName` | path | string | true | Group name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`groupName`|path|string|true|Group name| ### Example responses @@ -1824,9 +1824,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/groups/ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Group](schemas.md#codersdkgroup) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Group](schemas.md#codersdkgroup)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1845,10 +1845,10 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -1863,9 +1863,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceQuota](schemas.md#codersdkworkspacequota) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceQuota](schemas.md#codersdkworkspacequota)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1883,15 +1883,15 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------------------|---------------------|--------| -| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|101|[Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2)|Switching Protocols|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1910,9 +1910,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------|----------|-----------------| -| `organization` | path | string | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| ### Example responses @@ -1935,23 +1935,23 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerKey](schemas.md#codersdkprovisionerkey) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.ProvisionerKey](schemas.md#codersdkprovisionerkey)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|---------------------|----------------------------------------------------------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | false | | | -| `» id` | string(uuid) | false | | | -| `» name` | string | false | | | -| `» organization` | string(uuid) | false | | | -| `» tags` | [codersdk.ProvisionerKeyTags](schemas.md#codersdkprovisionerkeytags) | false | | | -| `»» [any property]` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|false||| +|`» id`|string(uuid)|false||| +|`» name`|string|false||| +|`» organization`|string(uuid)|false||| +|`» tags`|[codersdk.ProvisionerKeyTags](schemas.md#codersdkprovisionerkeytags)|false||| +|`»» [any property]`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1970,9 +1970,9 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/provis ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------|----------|-----------------| -| `organization` | path | string | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| ### Example responses @@ -1986,9 +1986,9 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/provis ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.CreateProvisionerKeyResponse](schemas.md#codersdkcreateprovisionerkeyresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.CreateProvisionerKeyResponse](schemas.md#codersdkcreateprovisionerkeyresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2007,9 +2007,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------|----------|-----------------| -| `organization` | path | string | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| ### Example responses @@ -2069,59 +2069,59 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerKeyDaemons](schemas.md#codersdkprovisionerkeydaemons) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.ProvisionerKeyDaemons](schemas.md#codersdkprovisionerkeydaemons)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-----------------------------|--------------------------------------------------------------------------------|----------|--------------|------------------| -| `[array item]` | array | false | | | -| `» daemons` | array | false | | | -| `»» api_version` | string | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» current_job` | [codersdk.ProvisionerDaemonJob](schemas.md#codersdkprovisionerdaemonjob) | false | | | -| `»»» id` | string(uuid) | false | | | -| `»»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | | -| `»»» template_display_name` | string | false | | | -| `»»» template_icon` | string | false | | | -| `»»» template_name` | string | false | | | -| `»» id` | string(uuid) | false | | | -| `»» key_id` | string(uuid) | false | | | -| `»» key_name` | string | false | | Optional fields. | -| `»» last_seen_at` | string(date-time) | false | | | -| `»» name` | string | false | | | -| `»» organization_id` | string(uuid) | false | | | -| `»» previous_job` | [codersdk.ProvisionerDaemonJob](schemas.md#codersdkprovisionerdaemonjob) | false | | | -| `»» provisioners` | array | false | | | -| `»» status` | [codersdk.ProvisionerDaemonStatus](schemas.md#codersdkprovisionerdaemonstatus) | false | | | -| `»» tags` | object | false | | | -| `»»» [any property]` | string | false | | | -| `»» version` | string | false | | | -| `» key` | [codersdk.ProvisionerKey](schemas.md#codersdkprovisionerkey) | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» id` | string(uuid) | false | | | -| `»» name` | string | false | | | -| `»» organization` | string(uuid) | false | | | -| `»» tags` | [codersdk.ProvisionerKeyTags](schemas.md#codersdkprovisionerkeytags) | false | | | -| `»»» [any property]` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» daemons`|array|false||| +|`»» api_version`|string|false||| +|`»» created_at`|string(date-time)|false||| +|`»» current_job`|[codersdk.ProvisionerDaemonJob](schemas.md#codersdkprovisionerdaemonjob)|false||| +|`»»» id`|string(uuid)|false||| +|`»»» status`|[codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus)|false||| +|`»»» template_display_name`|string|false||| +|`»»» template_icon`|string|false||| +|`»»» template_name`|string|false||| +|`»» id`|string(uuid)|false||| +|`»» key_id`|string(uuid)|false||| +|`»» key_name`|string|false||Optional fields.| +|`»» last_seen_at`|string(date-time)|false||| +|`»» name`|string|false||| +|`»» organization_id`|string(uuid)|false||| +|`»» previous_job`|[codersdk.ProvisionerDaemonJob](schemas.md#codersdkprovisionerdaemonjob)|false||| +|`»» provisioners`|array|false||| +|`»» status`|[codersdk.ProvisionerDaemonStatus](schemas.md#codersdkprovisionerdaemonstatus)|false||| +|`»» tags`|object|false||| +|`»»» [any property]`|string|false||| +|`»» version`|string|false||| +|`» key`|[codersdk.ProvisionerKey](schemas.md#codersdkprovisionerkey)|false||| +|`»» created_at`|string(date-time)|false||| +|`»» id`|string(uuid)|false||| +|`»» name`|string|false||| +|`»» organization`|string(uuid)|false||| +|`»» tags`|[codersdk.ProvisionerKeyTags](schemas.md#codersdkprovisionerkeytags)|false||| +|`»»» [any property]`|string|false||| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `status` | `offline` | -| `status` | `idle` | -| `status` | `busy` | +|Property|Value| +|---|---| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| +|`status`|`offline`| +|`status`|`idle`| +|`status`|`busy`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2139,16 +2139,16 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/prov ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------|----------|----------------------| -| `organization` | path | string | true | Organization ID | -| `provisionerkey` | path | string | true | Provisioner key name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| +|`provisionerkey`|path|string|true|Provisioner key name| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2167,9 +2167,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/setting ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -2183,9 +2183,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/setting ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of string | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of string|

Response Schema

@@ -2206,10 +2206,10 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/setting ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|----------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `claimField` | query | string(string) | true | Claim Field | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`claimField`|query|string(string)|true|Claim Field| ### Example responses @@ -2223,9 +2223,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/setting ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of string | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of string|

Response Schema

@@ -2246,9 +2246,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/setting ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -2276,9 +2276,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/setting ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2320,10 +2320,10 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------------------------------------------------------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `body` | body | [codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings) | true | New settings | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`body`|body|[codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings)|true|New settings| ### Example responses @@ -2351,9 +2351,9 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2383,10 +2383,10 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|----------------------------------------------------------------------------------------------|----------|-------------------------| -| `organization` | path | string(uuid) | true | Organization ID or name | -| `body` | body | [codersdk.PatchGroupIDPSyncConfigRequest](schemas.md#codersdkpatchgroupidpsyncconfigrequest) | true | New config values | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID or name| +|`body`|body|[codersdk.PatchGroupIDPSyncConfigRequest](schemas.md#codersdkpatchgroupidpsyncconfigrequest)|true|New config values| ### Example responses @@ -2414,9 +2414,9 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2455,10 +2455,10 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|------------------------------------------------------------------------------------------------|----------|-----------------------------------------------| -| `organization` | path | string(uuid) | true | Organization ID or name | -| `body` | body | [codersdk.PatchGroupIDPSyncMappingRequest](schemas.md#codersdkpatchgroupidpsyncmappingrequest) | true | Description of the mappings to add and remove | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID or name| +|`body`|body|[codersdk.PatchGroupIDPSyncMappingRequest](schemas.md#codersdkpatchgroupidpsyncmappingrequest)|true|Description of the mappings to add and remove| ### Example responses @@ -2486,9 +2486,9 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GroupSyncSettings](schemas.md#codersdkgroupsyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2507,9 +2507,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/setting ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -2531,9 +2531,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/setting ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2569,10 +2569,10 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|------------------------------------------------------------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `body` | body | [codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings) | true | New settings | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`body`|body|[codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings)|true|New settings| ### Example responses @@ -2594,9 +2594,9 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2624,10 +2624,10 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------------------------------------------------------------------------------------|----------|-------------------------| -| `organization` | path | string(uuid) | true | Organization ID or name | -| `body` | body | [codersdk.PatchRoleIDPSyncConfigRequest](schemas.md#codersdkpatchroleidpsyncconfigrequest) | true | New config values | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID or name| +|`body`|body|[codersdk.PatchRoleIDPSyncConfigRequest](schemas.md#codersdkpatchroleidpsyncconfigrequest)|true|New config values| ### Example responses @@ -2649,9 +2649,9 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2690,10 +2690,10 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|----------------------------------------------------------------------------------------------|----------|-----------------------------------------------| -| `organization` | path | string(uuid) | true | Organization ID or name | -| `body` | body | [codersdk.PatchRoleIDPSyncMappingRequest](schemas.md#codersdkpatchroleidpsyncmappingrequest) | true | Description of the mappings to add and remove | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID or name| +|`body`|body|[codersdk.PatchRoleIDPSyncMappingRequest](schemas.md#codersdkpatchroleidpsyncmappingrequest)|true|Description of the mappings to add and remove| ### Example responses @@ -2715,9 +2715,9 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/setti ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.RoleSyncSettings](schemas.md#codersdkrolesyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2735,9 +2735,9 @@ curl -X GET http://coder-server:8080/api/v2/provisionerkeys/{provisionerkey} \ ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------|----------|-----------------| -| `provisionerkey` | path | string | true | Provisioner Key | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`provisionerkey`|path|string|true|Provisioner Key| ### Example responses @@ -2758,9 +2758,9 @@ curl -X GET http://coder-server:8080/api/v2/provisionerkeys/{provisionerkey} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ProvisionerKey](schemas.md#codersdkprovisionerkey) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ProvisionerKey](schemas.md#codersdkprovisionerkey)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2797,24 +2797,24 @@ curl -X GET http://coder-server:8080/api/v2/replicas \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Replica](schemas.md#codersdkreplica) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Replica](schemas.md#codersdkreplica)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------------|-------------------|----------|--------------|--------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | 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(uuid) | 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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|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(uuid)|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.| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2832,9 +2832,9 @@ curl -X GET http://coder-server:8080/api/v2/scim/v2/ServiceProviderConfig ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| ## SCIM 2.0: Get users @@ -2850,9 +2850,9 @@ curl -X GET http://coder-server:8080/api/v2/scim/v2/Users \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2903,9 +2903,9 @@ curl -X POST http://coder-server:8080/api/v2/scim/v2/Users \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------|----------|-------------| -| `body` | body | [coderd.SCIMUser](schemas.md#coderdscimuser) | true | New user | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[coderd.SCIMUser](schemas.md#coderdscimuser)|true|New user| ### Example responses @@ -2942,9 +2942,9 @@ curl -X POST http://coder-server:8080/api/v2/scim/v2/Users \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [coderd.SCIMUser](schemas.md#coderdscimuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[coderd.SCIMUser](schemas.md#coderdscimuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2962,15 +2962,15 @@ curl -X GET http://coder-server:8080/api/v2/scim/v2/Users/{id} \ ### Parameters -| Name | In | Type | Required | Description | -|------|------|--------------|----------|-------------| -| `id` | path | string(uuid) | true | User ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`id`|path|string(uuid)|true|User ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|----------------------------------------------------------------|-------------|--------| -| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | Not Found | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3021,10 +3021,10 @@ curl -X PUT http://coder-server:8080/api/v2/scim/v2/Users/{id} \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------|----------|----------------------| -| `id` | path | string(uuid) | true | User ID | -| `body` | body | [coderd.SCIMUser](schemas.md#coderdscimuser) | true | Replace user request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`id`|path|string(uuid)|true|User ID| +|`body`|body|[coderd.SCIMUser](schemas.md#coderdscimuser)|true|Replace user request| ### Example responses @@ -3058,9 +3058,9 @@ curl -X PUT http://coder-server:8080/api/v2/scim/v2/Users/{id} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3111,10 +3111,10 @@ curl -X PATCH http://coder-server:8080/api/v2/scim/v2/Users/{id} \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------|----------|---------------------| -| `id` | path | string(uuid) | true | User ID | -| `body` | body | [coderd.SCIMUser](schemas.md#coderdscimuser) | true | Update user request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`id`|path|string(uuid)|true|User ID| +|`body`|body|[coderd.SCIMUser](schemas.md#coderdscimuser)|true|Update user request| ### Example responses @@ -3148,9 +3148,9 @@ curl -X PATCH http://coder-server:8080/api/v2/scim/v2/Users/{id} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3169,9 +3169,9 @@ curl -X GET http://coder-server:8080/api/v2/settings/idpsync/available-fields \ ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -3185,9 +3185,9 @@ curl -X GET http://coder-server:8080/api/v2/settings/idpsync/available-fields \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of string | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of string|

Response Schema

@@ -3208,10 +3208,10 @@ curl -X GET http://coder-server:8080/api/v2/settings/idpsync/field-values?claimF ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|----------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `claimField` | query | string(string) | true | Claim Field | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`claimField`|query|string(string)|true|Claim Field| ### Example responses @@ -3225,9 +3225,9 @@ curl -X GET http://coder-server:8080/api/v2/settings/idpsync/field-values?claimF ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of string | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of string|

Response Schema

@@ -3267,9 +3267,9 @@ curl -X GET http://coder-server:8080/api/v2/settings/idpsync/organization \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3306,9 +3306,9 @@ curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------|----------|--------------| -| `body` | body | [codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings) | true | New settings | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings)|true|New settings| ### Example responses @@ -3331,9 +3331,9 @@ curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3362,9 +3362,9 @@ curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization/conf ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------------------------------------|----------|-------------------| -| `body` | body | [codersdk.PatchOrganizationIDPSyncConfigRequest](schemas.md#codersdkpatchorganizationidpsyncconfigrequest) | true | New config values | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.PatchOrganizationIDPSyncConfigRequest](schemas.md#codersdkpatchorganizationidpsyncconfigrequest)|true|New config values| ### Example responses @@ -3387,9 +3387,9 @@ curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization/conf ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3428,9 +3428,9 @@ curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization/mapp ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------------| -| `body` | body | [codersdk.PatchOrganizationIDPSyncMappingRequest](schemas.md#codersdkpatchorganizationidpsyncmappingrequest) | true | Description of the mappings to add and remove | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.PatchOrganizationIDPSyncMappingRequest](schemas.md#codersdkpatchorganizationidpsyncmappingrequest)|true|Description of the mappings to add and remove| ### Example responses @@ -3453,9 +3453,9 @@ curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization/mapp ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OrganizationSyncSettings](schemas.md#codersdkorganizationsyncsettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3474,9 +3474,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/acl \ ### Parameters -| Name | In | Type | Required | Description | -|------------|------|--------------|----------|-------------| -| `template` | path | string(uuid) | true | Template ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| ### Example responses @@ -3545,9 +3545,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/acl \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateACL](schemas.md#codersdktemplateacl) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.TemplateACL](schemas.md#codersdktemplateacl)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3582,10 +3582,10 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/acl \ ### Parameters -| Name | In | Type | Required | Description | -|------------|------|--------------------------------------------------------------------|----------|-------------------------| -| `template` | path | string(uuid) | true | Template ID | -| `body` | body | [codersdk.UpdateTemplateACL](schemas.md#codersdkupdatetemplateacl) | true | Update template request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| +|`body`|body|[codersdk.UpdateTemplateACL](schemas.md#codersdkupdatetemplateacl)|true|Update template request| ### Example responses @@ -3606,9 +3606,9 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/acl \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3627,9 +3627,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/acl/available \ ### Parameters -| Name | In | Type | Required | Description | -|------------|------|--------------|----------|-------------| -| `template` | path | string(uuid) | true | Template ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| ### Example responses @@ -3688,56 +3688,56 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/acl/available \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ACLAvailable](schemas.md#codersdkaclavailable) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.ACLAvailable](schemas.md#codersdkaclavailable)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|--------------------------------|--------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» groups` | array | false | | | -| `»» avatar_url` | string(uri) | false | | | -| `»» display_name` | string | false | | | -| `»» id` | string(uuid) | false | | | -| `»» members` | array | false | | | -| `»»» avatar_url` | string(uri) | false | | | -| `»»» created_at` | string(date-time) | true | | | -| `»»» email` | string(email) | true | | | -| `»»» id` | string(uuid) | true | | | -| `»»» last_seen_at` | string(date-time) | false | | | -| `»»» login_type` | [codersdk.LoginType](schemas.md#codersdklogintype) | false | | | -| `»»» name` | string | false | | | -| `»»» status` | [codersdk.UserStatus](schemas.md#codersdkuserstatus) | false | | | -| `»»» theme_preference` | string | false | | Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead. | -| `»»» updated_at` | string(date-time) | false | | | -| `»»» username` | string | true | | | -| `»» name` | string | false | | | -| `»» organization_display_name` | string | false | | | -| `»» organization_id` | string(uuid) | false | | | -| `»» organization_name` | string | false | | | -| `»» quota_allowance` | integer | false | | | -| `»» source` | [codersdk.GroupSource](schemas.md#codersdkgroupsource) | false | | | -| `»» total_member_count` | integer | false | | How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`. | -| `» users` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» groups`|array|false||| +|`»» avatar_url`|string(uri)|false||| +|`»» display_name`|string|false||| +|`»» id`|string(uuid)|false||| +|`»» members`|array|false||| +|`»»» avatar_url`|string(uri)|false||| +|`»»» created_at`|string(date-time)|true||| +|`»»» email`|string(email)|true||| +|`»»» id`|string(uuid)|true||| +|`»»» last_seen_at`|string(date-time)|false||| +|`»»» login_type`|[codersdk.LoginType](schemas.md#codersdklogintype)|false||| +|`»»» name`|string|false||| +|`»»» status`|[codersdk.UserStatus](schemas.md#codersdkuserstatus)|false||| +|`»»» theme_preference`|string|false||Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead.| +|`»»» updated_at`|string(date-time)|false||| +|`»»» username`|string|true||| +|`»» name`|string|false||| +|`»» organization_display_name`|string|false||| +|`»» organization_id`|string(uuid)|false||| +|`»» organization_name`|string|false||| +|`»» quota_allowance`|integer|false||| +|`»» source`|[codersdk.GroupSource](schemas.md#codersdkgroupsource)|false||| +|`»» total_member_count`|integer|false||How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`.| +|`» users`|array|false||| #### Enumerated Values -| Property | Value | -|--------------|-------------| -| `login_type` | `` | -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `login_type` | `none` | -| `status` | `active` | -| `status` | `suspended` | -| `source` | `user` | -| `source` | `oidc` | +|Property|Value| +|---|---| +|`login_type`|``| +|`login_type`|`password`| +|`login_type`|`github`| +|`login_type`|`oidc`| +|`login_type`|`token`| +|`login_type`|`none`| +|`status`|`active`| +|`status`|`suspended`| +|`source`|`user`| +|`source`|`oidc`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3756,9 +3756,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/quiet-hours \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------|----------|-------------| -| `user` | path | string(uuid) | true | User ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string(uuid)|true|User ID| ### Example responses @@ -3779,23 +3779,23 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/quiet-hours \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.UserQuietHoursScheduleResponse](schemas.md#codersdkuserquiethoursscheduleresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.UserQuietHoursScheduleResponse](schemas.md#codersdkuserquiethoursscheduleresponse)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------|-------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» next` | string(date-time) | 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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» next`|string(date-time)|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.| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3823,10 +3823,10 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/quiet-hours \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------------------------------------------|----------|-------------------------| -| `user` | path | string(uuid) | true | User ID | -| `body` | body | [codersdk.UpdateUserQuietHoursScheduleRequest](schemas.md#codersdkupdateuserquiethoursschedulerequest) | true | Update schedule request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string(uuid)|true|User ID| +|`body`|body|[codersdk.UpdateUserQuietHoursScheduleRequest](schemas.md#codersdkupdateuserquiethoursschedulerequest)|true|Update schedule request| ### Example responses @@ -3847,23 +3847,23 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/quiet-hours \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.UserQuietHoursScheduleResponse](schemas.md#codersdkuserquiethoursscheduleresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.UserQuietHoursScheduleResponse](schemas.md#codersdkuserquiethoursscheduleresponse)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------|-------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» next` | string(date-time) | 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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» next`|string(date-time)|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.| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3882,9 +3882,9 @@ curl -X GET http://coder-server:8080/api/v2/workspace-quota/{user} \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -3899,9 +3899,9 @@ curl -X GET http://coder-server:8080/api/v2/workspace-quota/{user} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceQuota](schemas.md#codersdkworkspacequota) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceQuota](schemas.md#codersdkworkspacequota)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3960,46 +3960,46 @@ curl -X GET http://coder-server:8080/api/v2/workspaceproxies \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.RegionsResponse-codersdk_WorkspaceProxy](schemas.md#codersdkregionsresponse-codersdk_workspaceproxy) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.RegionsResponse-codersdk_WorkspaceProxy](schemas.md#codersdkregionsresponse-codersdk_workspaceproxy)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------------|--------------------------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» regions` | array | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» deleted` | boolean | false | | | -| `»» derp_enabled` | boolean | false | | | -| `»» derp_only` | boolean | false | | | -| `»» display_name` | string | false | | | -| `»» healthy` | boolean | false | | | -| `»» icon_url` | string | false | | | -| `»» id` | string(uuid) | 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](schemas.md#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. | -| `»»» checked_at` | string(date-time) | false | | | -| `»»» report` | [codersdk.ProxyHealthReport](schemas.md#codersdkproxyhealthreport) | false | | Report provides more information about the health of the workspace proxy. | -| `»»»» errors` | array | false | | Errors are problems that prevent the workspace proxy from being healthy | -| `»»»» warnings` | array | false | | Warnings do not prevent the workspace proxy from being healthy, but should be addressed. | -| `»»» status` | [codersdk.ProxyHealthStatus](schemas.md#codersdkproxyhealthstatus) | false | | | -| `»» updated_at` | string(date-time) | false | | | -| `»» version` | string | false | | | -| `»» 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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» regions`|array|false||| +|`»» created_at`|string(date-time)|false||| +|`»» deleted`|boolean|false||| +|`»» derp_enabled`|boolean|false||| +|`»» derp_only`|boolean|false||| +|`»» display_name`|string|false||| +|`»» healthy`|boolean|false||| +|`»» icon_url`|string|false||| +|`»» id`|string(uuid)|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](schemas.md#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.| +|`»»» checked_at`|string(date-time)|false||| +|`»»» report`|[codersdk.ProxyHealthReport](schemas.md#codersdkproxyhealthreport)|false||Report provides more information about the health of the workspace proxy.| +|`»»»» errors`|array|false||Errors are problems that prevent the workspace proxy from being healthy| +|`»»»» warnings`|array|false||Warnings do not prevent the workspace proxy from being healthy, but should be addressed.| +|`»»» status`|[codersdk.ProxyHealthStatus](schemas.md#codersdkproxyhealthstatus)|false||| +|`»» updated_at`|string(date-time)|false||| +|`»» version`|string|false||| +|`»» 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.| #### Enumerated Values -| Property | Value | -|----------|----------------| -| `status` | `ok` | -| `status` | `unreachable` | -| `status` | `unhealthy` | -| `status` | `unregistered` | +|Property|Value| +|---|---| +|`status`|`ok`| +|`status`|`unreachable`| +|`status`|`unhealthy`| +|`status`|`unregistered`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -4029,9 +4029,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceproxies \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------------|----------|--------------------------------| -| `body` | body | [codersdk.CreateWorkspaceProxyRequest](schemas.md#codersdkcreateworkspaceproxyrequest) | true | Create workspace proxy request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.CreateWorkspaceProxyRequest](schemas.md#codersdkcreateworkspaceproxyrequest)|true|Create workspace proxy request| ### Example responses @@ -4069,9 +4069,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaceproxies \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.WorkspaceProxy](schemas.md#codersdkworkspaceproxy) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.WorkspaceProxy](schemas.md#codersdkworkspaceproxy)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -4090,9 +4090,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} \ ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|------------------| -| `workspaceproxy` | path | string(uuid) | true | Proxy ID or name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceproxy`|path|string(uuid)|true|Proxy ID or name| ### Example responses @@ -4130,9 +4130,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceProxy](schemas.md#codersdkworkspaceproxy) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceProxy](schemas.md#codersdkworkspaceproxy)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -4151,9 +4151,9 @@ curl -X DELETE http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|--------------|----------|------------------| -| `workspaceproxy` | path | string(uuid) | true | Proxy ID or name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceproxy`|path|string(uuid)|true|Proxy ID or name| ### Example responses @@ -4174,9 +4174,9 @@ curl -X DELETE http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -4208,10 +4208,10 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} ### Parameters -| Name | In | Type | Required | Description | -|------------------|------|------------------------------------------------------------------------|----------|--------------------------------| -| `workspaceproxy` | path | string(uuid) | true | Proxy ID or name | -| `body` | body | [codersdk.PatchWorkspaceProxy](schemas.md#codersdkpatchworkspaceproxy) | true | Update workspace proxy request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspaceproxy`|path|string(uuid)|true|Proxy ID or name| +|`body`|body|[codersdk.PatchWorkspaceProxy](schemas.md#codersdkpatchworkspaceproxy)|true|Update workspace proxy request| ### Example responses @@ -4249,8 +4249,8 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceProxy](schemas.md#codersdkworkspaceproxy) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceProxy](schemas.md#codersdkworkspaceproxy)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/files.md b/docs/reference/api/files.md index 7b937876bbf3b..4c634830d4830 100644 --- a/docs/reference/api/files.md +++ b/docs/reference/api/files.md @@ -23,11 +23,11 @@ file: string ### Parameters -| Name | In | Type | Required | Description | -|----------------|--------|--------|----------|------------------------------------------------------------------------------------------------| -| `Content-Type` | header | string | true | Content-Type must be `application/x-tar` or `application/zip` | -| `body` | body | object | true | | -| `» file` | body | binary | true | File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems). | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`Content-Type`|header|string|true|Content-Type must be `application/x-tar` or `application/zip`| +|`body`|body|object|true|| +|`» file`|body|binary|true|File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems).| ### Example responses @@ -41,9 +41,9 @@ file: string ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.UploadResponse](schemas.md#codersdkuploadresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.UploadResponse](schemas.md#codersdkuploadresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -61,14 +61,14 @@ curl -X GET http://coder-server:8080/api/v2/files/{fileID} \ ### Parameters -| Name | In | Type | Required | Description | -|----------|------|--------------|----------|-------------| -| `fileID` | path | string(uuid) | true | File ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`fileID`|path|string(uuid)|true|File ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/general.md b/docs/reference/api/general.md index 72543f6774dfd..0d32b31728d16 100644 --- a/docs/reference/api/general.md +++ b/docs/reference/api/general.md @@ -31,9 +31,9 @@ curl -X GET http://coder-server:8080/api/v2/ \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| ## Build info @@ -68,9 +68,9 @@ curl -X GET http://coder-server:8080/api/v2/buildinfo \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.BuildInfoResponse](schemas.md#codersdkbuildinforesponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.BuildInfoResponse](schemas.md#codersdkbuildinforesponse)| ## Report CSP violations @@ -95,15 +95,15 @@ curl -X POST http://coder-server:8080/api/v2/csp/reports \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------|----------|------------------| -| `body` | body | [coderd.cspViolation](schemas.md#coderdcspviolation) | true | Violation report | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[coderd.cspViolation](schemas.md#coderdcspviolation)|true|Violation report| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -566,9 +566,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentConfig](schemas.md#codersdkdeploymentconfig) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.DeploymentConfig](schemas.md#codersdkdeploymentconfig)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -602,9 +602,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/ssh \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.SSHConfigResponse](schemas.md#codersdksshconfigresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.SSHConfigResponse](schemas.md#codersdksshconfigresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -654,9 +654,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/stats \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentStats](schemas.md#codersdkdeploymentstats) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.DeploymentStats](schemas.md#codersdkdeploymentstats)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -685,17 +685,17 @@ curl -X GET http://coder-server:8080/api/v2/experiments \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Experiment](schemas.md#codersdkexperiment)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|-------|----------|--------------|-------------| -| `[array item]` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -724,17 +724,17 @@ curl -X GET http://coder-server:8080/api/v2/experiments/available \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Experiment](schemas.md#codersdkexperiment)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|-------|----------|--------------|-------------| -| `[array item]` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -764,9 +764,9 @@ curl -X GET http://coder-server:8080/api/v2/updatecheck \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UpdateCheckResponse](schemas.md#codersdkupdatecheckresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.UpdateCheckResponse](schemas.md#codersdkupdatecheckresponse)| ## Get token config @@ -783,9 +783,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/tokenconfig ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -799,8 +799,8 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/tokenconfig ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TokenConfig](schemas.md#codersdktokenconfig) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.TokenConfig](schemas.md#codersdktokenconfig)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/git.md b/docs/reference/api/git.md index fc36f184a7c97..72a710ec95d7e 100644 --- a/docs/reference/api/git.md +++ b/docs/reference/api/git.md @@ -31,9 +31,9 @@ curl -X GET http://coder-server:8080/api/v2/external-auth \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuthLink](schemas.md#codersdkexternalauthlink) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ExternalAuthLink](schemas.md#codersdkexternalauthlink)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -52,9 +52,9 @@ curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth} \ ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|----------------|----------|-----------------| -| `externalauth` | path | string(string) | true | Git Provider ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`externalauth`|path|string(string)|true|Git Provider ID| ### Example responses @@ -92,9 +92,9 @@ curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuth](schemas.md#codersdkexternalauth) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ExternalAuth](schemas.md#codersdkexternalauth)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -112,15 +112,15 @@ curl -X DELETE http://coder-server:8080/api/v2/external-auth/{externalauth} \ ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|----------------|----------|-----------------| -| `externalauth` | path | string(string) | true | Git Provider ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`externalauth`|path|string(string)|true|Git Provider ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -139,9 +139,9 @@ curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth}/device ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|----------------|----------|-----------------| -| `externalauth` | path | string(string) | true | Git Provider ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`externalauth`|path|string(string)|true|Git Provider ID| ### Example responses @@ -159,9 +159,9 @@ curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth}/device ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuthDevice](schemas.md#codersdkexternalauthdevice) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ExternalAuthDevice](schemas.md#codersdkexternalauthdevice)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -179,14 +179,14 @@ curl -X POST http://coder-server:8080/api/v2/external-auth/{externalauth}/device ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|----------------|----------|----------------------| -| `externalauth` | path | string(string) | true | External Provider ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`externalauth`|path|string(string)|true|External Provider ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/insights.md b/docs/reference/api/insights.md index b8fcdbbb1e776..ed0c104c0f6ee 100644 --- a/docs/reference/api/insights.md +++ b/docs/reference/api/insights.md @@ -15,9 +15,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/daus?tz_offset=0 \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|-------|---------|----------|----------------------------| -| `tz_offset` | query | integer | true | Time-zone offset (e.g. -2) | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`tz_offset`|query|integer|true|Time-zone offset (e.g. -2)| ### Example responses @@ -37,9 +37,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/daus?tz_offset=0 \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DAUsResponse](schemas.md#codersdkdausresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.DAUsResponse](schemas.md#codersdkdausresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -58,19 +58,19 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0 ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|-------------------|----------|--------------| -| `start_time` | query | string(date-time) | true | Start time | -| `end_time` | query | string(date-time) | true | End time | -| `interval` | query | string | true | Interval | -| `template_ids` | query | array[string] | false | Template IDs | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`start_time`|query|string(date-time)|true|Start time| +|`end_time`|query|string(date-time)|true|End time| +|`interval`|query|string|true|Interval| +|`template_ids`|query|array[string]|false|Template IDs| #### Enumerated Values -| Parameter | Value | -|------------|--------| -| `interval` | `week` | -| `interval` | `day` | +|Parameter|Value| +|---|---| +|`interval`|`week`| +|`interval`|`day`| ### Example responses @@ -140,9 +140,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0 ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateInsightsResponse](schemas.md#codersdktemplateinsightsresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.TemplateInsightsResponse](schemas.md#codersdktemplateinsightsresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -161,11 +161,11 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-activity?start_time=20 ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|-------------------|----------|--------------| -| `start_time` | query | string(date-time) | true | Start time | -| `end_time` | query | string(date-time) | true | End time | -| `template_ids` | query | array[string] | false | Template IDs | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`start_time`|query|string(date-time)|true|Start time| +|`end_time`|query|string(date-time)|true|End time| +|`template_ids`|query|array[string]|false|Template IDs| ### Example responses @@ -196,9 +196,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-activity?start_time=20 ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserActivityInsightsResponse](schemas.md#codersdkuseractivityinsightsresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.UserActivityInsightsResponse](schemas.md#codersdkuseractivityinsightsresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -217,11 +217,11 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-latency?start_time=201 ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|-------------------|----------|--------------| -| `start_time` | query | string(date-time) | true | Start time | -| `end_time` | query | string(date-time) | true | End time | -| `template_ids` | query | array[string] | false | Template IDs | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`start_time`|query|string(date-time)|true|Start time| +|`end_time`|query|string(date-time)|true|End time| +|`template_ids`|query|array[string]|false|Template IDs| ### Example responses @@ -255,9 +255,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-latency?start_time=201 ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserLatencyInsightsResponse](schemas.md#codersdkuserlatencyinsightsresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.UserLatencyInsightsResponse](schemas.md#codersdkuserlatencyinsightsresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -276,9 +276,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-status-counts?tz_offse ### Parameters -| Name | In | Type | Required | Description | -|-------------|-------|---------|----------|----------------------------| -| `tz_offset` | query | integer | true | Time-zone offset (e.g. -2) | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`tz_offset`|query|integer|true|Time-zone offset (e.g. -2)| ### Example responses @@ -305,8 +305,8 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-status-counts?tz_offse ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GetUserStatusCountsResponse](schemas.md#codersdkgetuserstatuscountsresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GetUserStatusCountsResponse](schemas.md#codersdkgetuserstatuscountsresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/members.md b/docs/reference/api/members.md index 4b0adbf45e338..89353394182b5 100644 --- a/docs/reference/api/members.md +++ b/docs/reference/api/members.md @@ -15,9 +15,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------|----------|-----------------| -| `organization` | path | string | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| ### Example responses @@ -54,30 +54,30 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.OrganizationMemberWithUserData](schemas.md#codersdkorganizationmemberwithuserdata) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.OrganizationMemberWithUserData](schemas.md#codersdkorganizationmemberwithuserdata)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------------|-------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» avatar_url` | string | false | | | -| `» created_at` | string(date-time) | false | | | -| `» email` | string | false | | | -| `» global_roles` | array | false | | | -| `»» display_name` | string | false | | | -| `»» name` | string | false | | | -| `»» organization_id` | string | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» roles` | array | false | | | -| `» updated_at` | string(date-time) | false | | | -| `» user_id` | string(uuid) | false | | | -| `» username` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» avatar_url`|string|false||| +|`» created_at`|string(date-time)|false||| +|`» email`|string|false||| +|`» global_roles`|array|false||| +|`»» display_name`|string|false||| +|`»» name`|string|false||| +|`»» organization_id`|string|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» roles`|array|false||| +|`» updated_at`|string(date-time)|false||| +|`» user_id`|string(uuid)|false||| +|`» username`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -96,9 +96,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -139,87 +139,87 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» assignable` | boolean | false | | | -| `» built_in` | boolean | false | | Built in roles are immutable | -| `» display_name` | string | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. | -| `»» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | | -| `»» negate` | boolean | false | | Negate makes this a negative permission | -| `»» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | | -| `» site_permissions` | array | false | | | -| `» user_permissions` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» assignable`|boolean|false||| +|`» built_in`|boolean|false||Built in roles are immutable| +|`» display_name`|string|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» organization_permissions`|array|false||Organization permissions are specific for the organization in the field 'OrganizationID' above.| +|`»» action`|[codersdk.RBACAction](schemas.md#codersdkrbacaction)|false||| +|`»» negate`|boolean|false||Negate makes this a negative permission| +|`»» resource_type`|[codersdk.RBACResource](schemas.md#codersdkrbacresource)|false||| +|`» site_permissions`|array|false||| +|`» user_permissions`|array|false||| #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `template` | -| `resource_type` | `user` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +|Property|Value| +|---|---| +|`action`|`application_connect`| +|`action`|`assign`| +|`action`|`create`| +|`action`|`create_agent`| +|`action`|`delete`| +|`action`|`delete_agent`| +|`action`|`read`| +|`action`|`read_personal`| +|`action`|`ssh`| +|`action`|`unassign`| +|`action`|`update`| +|`action`|`update_personal`| +|`action`|`use`| +|`action`|`view_insights`| +|`action`|`start`| +|`action`|`stop`| +|`resource_type`|`*`| +|`resource_type`|`api_key`| +|`resource_type`|`assign_org_role`| +|`resource_type`|`assign_role`| +|`resource_type`|`audit_log`| +|`resource_type`|`connection_log`| +|`resource_type`|`crypto_key`| +|`resource_type`|`debug_info`| +|`resource_type`|`deployment_config`| +|`resource_type`|`deployment_stats`| +|`resource_type`|`file`| +|`resource_type`|`group`| +|`resource_type`|`group_member`| +|`resource_type`|`idpsync_settings`| +|`resource_type`|`inbox_notification`| +|`resource_type`|`license`| +|`resource_type`|`notification_message`| +|`resource_type`|`notification_preference`| +|`resource_type`|`notification_template`| +|`resource_type`|`oauth2_app`| +|`resource_type`|`oauth2_app_code_token`| +|`resource_type`|`oauth2_app_secret`| +|`resource_type`|`organization`| +|`resource_type`|`organization_member`| +|`resource_type`|`prebuilt_workspace`| +|`resource_type`|`provisioner_daemon`| +|`resource_type`|`provisioner_jobs`| +|`resource_type`|`replicas`| +|`resource_type`|`system`| +|`resource_type`|`tailnet_coordinator`| +|`resource_type`|`template`| +|`resource_type`|`user`| +|`resource_type`|`webpush_subscription`| +|`resource_type`|`workspace`| +|`resource_type`|`workspace_agent_devcontainers`| +|`resource_type`|`workspace_agent_resource_monitor`| +|`resource_type`|`workspace_dormant`| +|`resource_type`|`workspace_proxy`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -269,10 +269,10 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------------------------------------------------------------|----------|---------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `body` | body | [codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest) | true | Upsert role request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`body`|body|[codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest)|true|Upsert role request| ### Example responses @@ -311,85 +311,85 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Role](schemas.md#codersdkrole)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» display_name` | string | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. | -| `»» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | | -| `»» negate` | boolean | false | | Negate makes this a negative permission | -| `»» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | | -| `» site_permissions` | array | false | | | -| `» user_permissions` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» display_name`|string|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» organization_permissions`|array|false||Organization permissions are specific for the organization in the field 'OrganizationID' above.| +|`»» action`|[codersdk.RBACAction](schemas.md#codersdkrbacaction)|false||| +|`»» negate`|boolean|false||Negate makes this a negative permission| +|`»» resource_type`|[codersdk.RBACResource](schemas.md#codersdkrbacresource)|false||| +|`» site_permissions`|array|false||| +|`» user_permissions`|array|false||| #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `template` | -| `resource_type` | `user` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +|Property|Value| +|---|---| +|`action`|`application_connect`| +|`action`|`assign`| +|`action`|`create`| +|`action`|`create_agent`| +|`action`|`delete`| +|`action`|`delete_agent`| +|`action`|`read`| +|`action`|`read_personal`| +|`action`|`ssh`| +|`action`|`unassign`| +|`action`|`update`| +|`action`|`update_personal`| +|`action`|`use`| +|`action`|`view_insights`| +|`action`|`start`| +|`action`|`stop`| +|`resource_type`|`*`| +|`resource_type`|`api_key`| +|`resource_type`|`assign_org_role`| +|`resource_type`|`assign_role`| +|`resource_type`|`audit_log`| +|`resource_type`|`connection_log`| +|`resource_type`|`crypto_key`| +|`resource_type`|`debug_info`| +|`resource_type`|`deployment_config`| +|`resource_type`|`deployment_stats`| +|`resource_type`|`file`| +|`resource_type`|`group`| +|`resource_type`|`group_member`| +|`resource_type`|`idpsync_settings`| +|`resource_type`|`inbox_notification`| +|`resource_type`|`license`| +|`resource_type`|`notification_message`| +|`resource_type`|`notification_preference`| +|`resource_type`|`notification_template`| +|`resource_type`|`oauth2_app`| +|`resource_type`|`oauth2_app_code_token`| +|`resource_type`|`oauth2_app_secret`| +|`resource_type`|`organization`| +|`resource_type`|`organization_member`| +|`resource_type`|`prebuilt_workspace`| +|`resource_type`|`provisioner_daemon`| +|`resource_type`|`provisioner_jobs`| +|`resource_type`|`replicas`| +|`resource_type`|`system`| +|`resource_type`|`tailnet_coordinator`| +|`resource_type`|`template`| +|`resource_type`|`user`| +|`resource_type`|`webpush_subscription`| +|`resource_type`|`workspace`| +|`resource_type`|`workspace_agent_devcontainers`| +|`resource_type`|`workspace_agent_resource_monitor`| +|`resource_type`|`workspace_dormant`| +|`resource_type`|`workspace_proxy`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -439,10 +439,10 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------------------------------------------------------------|----------|---------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `body` | body | [codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest) | true | Insert role request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`body`|body|[codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest)|true|Insert role request| ### Example responses @@ -481,85 +481,85 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Role](schemas.md#codersdkrole)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» display_name` | string | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. | -| `»» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | | -| `»» negate` | boolean | false | | Negate makes this a negative permission | -| `»» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | | -| `» site_permissions` | array | false | | | -| `» user_permissions` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» display_name`|string|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» organization_permissions`|array|false||Organization permissions are specific for the organization in the field 'OrganizationID' above.| +|`»» action`|[codersdk.RBACAction](schemas.md#codersdkrbacaction)|false||| +|`»» negate`|boolean|false||Negate makes this a negative permission| +|`»» resource_type`|[codersdk.RBACResource](schemas.md#codersdkrbacresource)|false||| +|`» site_permissions`|array|false||| +|`» user_permissions`|array|false||| #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `template` | -| `resource_type` | `user` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +|Property|Value| +|---|---| +|`action`|`application_connect`| +|`action`|`assign`| +|`action`|`create`| +|`action`|`create_agent`| +|`action`|`delete`| +|`action`|`delete_agent`| +|`action`|`read`| +|`action`|`read_personal`| +|`action`|`ssh`| +|`action`|`unassign`| +|`action`|`update`| +|`action`|`update_personal`| +|`action`|`use`| +|`action`|`view_insights`| +|`action`|`start`| +|`action`|`stop`| +|`resource_type`|`*`| +|`resource_type`|`api_key`| +|`resource_type`|`assign_org_role`| +|`resource_type`|`assign_role`| +|`resource_type`|`audit_log`| +|`resource_type`|`connection_log`| +|`resource_type`|`crypto_key`| +|`resource_type`|`debug_info`| +|`resource_type`|`deployment_config`| +|`resource_type`|`deployment_stats`| +|`resource_type`|`file`| +|`resource_type`|`group`| +|`resource_type`|`group_member`| +|`resource_type`|`idpsync_settings`| +|`resource_type`|`inbox_notification`| +|`resource_type`|`license`| +|`resource_type`|`notification_message`| +|`resource_type`|`notification_preference`| +|`resource_type`|`notification_template`| +|`resource_type`|`oauth2_app`| +|`resource_type`|`oauth2_app_code_token`| +|`resource_type`|`oauth2_app_secret`| +|`resource_type`|`organization`| +|`resource_type`|`organization_member`| +|`resource_type`|`prebuilt_workspace`| +|`resource_type`|`provisioner_daemon`| +|`resource_type`|`provisioner_jobs`| +|`resource_type`|`replicas`| +|`resource_type`|`system`| +|`resource_type`|`tailnet_coordinator`| +|`resource_type`|`template`| +|`resource_type`|`user`| +|`resource_type`|`webpush_subscription`| +|`resource_type`|`workspace`| +|`resource_type`|`workspace_agent_devcontainers`| +|`resource_type`|`workspace_agent_resource_monitor`| +|`resource_type`|`workspace_dormant`| +|`resource_type`|`workspace_proxy`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -578,10 +578,10 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/memb ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `roleName` | path | string | true | Role name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`roleName`|path|string|true|Role name| ### Example responses @@ -620,85 +620,85 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/memb ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Role](schemas.md#codersdkrole)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» display_name` | string | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. | -| `»» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | | -| `»» negate` | boolean | false | | Negate makes this a negative permission | -| `»» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | | -| `» site_permissions` | array | false | | | -| `» user_permissions` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» display_name`|string|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» organization_permissions`|array|false||Organization permissions are specific for the organization in the field 'OrganizationID' above.| +|`»» action`|[codersdk.RBACAction](schemas.md#codersdkrbacaction)|false||| +|`»» negate`|boolean|false||Negate makes this a negative permission| +|`»» resource_type`|[codersdk.RBACResource](schemas.md#codersdkrbacresource)|false||| +|`» site_permissions`|array|false||| +|`» user_permissions`|array|false||| #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `template` | -| `resource_type` | `user` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +|Property|Value| +|---|---| +|`action`|`application_connect`| +|`action`|`assign`| +|`action`|`create`| +|`action`|`create_agent`| +|`action`|`delete`| +|`action`|`delete_agent`| +|`action`|`read`| +|`action`|`read_personal`| +|`action`|`ssh`| +|`action`|`unassign`| +|`action`|`update`| +|`action`|`update_personal`| +|`action`|`use`| +|`action`|`view_insights`| +|`action`|`start`| +|`action`|`stop`| +|`resource_type`|`*`| +|`resource_type`|`api_key`| +|`resource_type`|`assign_org_role`| +|`resource_type`|`assign_role`| +|`resource_type`|`audit_log`| +|`resource_type`|`connection_log`| +|`resource_type`|`crypto_key`| +|`resource_type`|`debug_info`| +|`resource_type`|`deployment_config`| +|`resource_type`|`deployment_stats`| +|`resource_type`|`file`| +|`resource_type`|`group`| +|`resource_type`|`group_member`| +|`resource_type`|`idpsync_settings`| +|`resource_type`|`inbox_notification`| +|`resource_type`|`license`| +|`resource_type`|`notification_message`| +|`resource_type`|`notification_preference`| +|`resource_type`|`notification_template`| +|`resource_type`|`oauth2_app`| +|`resource_type`|`oauth2_app_code_token`| +|`resource_type`|`oauth2_app_secret`| +|`resource_type`|`organization`| +|`resource_type`|`organization_member`| +|`resource_type`|`prebuilt_workspace`| +|`resource_type`|`provisioner_daemon`| +|`resource_type`|`provisioner_jobs`| +|`resource_type`|`replicas`| +|`resource_type`|`system`| +|`resource_type`|`tailnet_coordinator`| +|`resource_type`|`template`| +|`resource_type`|`user`| +|`resource_type`|`webpush_subscription`| +|`resource_type`|`workspace`| +|`resource_type`|`workspace_agent_devcontainers`| +|`resource_type`|`workspace_agent_resource_monitor`| +|`resource_type`|`workspace_dormant`| +|`resource_type`|`workspace_proxy`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -717,10 +717,10 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------|----------|----------------------| -| `organization` | path | string | true | Organization ID | -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -744,9 +744,9 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OrganizationMember](schemas.md#codersdkorganizationmember)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -764,16 +764,16 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/memb ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------|----------|----------------------| -| `organization` | path | string | true | Organization ID | -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| +|`user`|path|string|true|User ID, name, or me| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -803,11 +803,11 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------------------------------------------------|----------|----------------------| -| `organization` | path | string | true | Organization ID | -| `user` | path | string | true | User ID, name, or me | -| `body` | body | [codersdk.UpdateRoles](schemas.md#codersdkupdateroles) | true | Update roles request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| +|`user`|path|string|true|User ID, name, or me| +|`body`|body|[codersdk.UpdateRoles](schemas.md#codersdkupdateroles)|true|Update roles request| ### Example responses @@ -831,9 +831,9 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.OrganizationMember](schemas.md#codersdkorganizationmember)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -852,11 +852,11 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/paginat ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|---------|----------|--------------------------------------| -| `organization` | path | string | true | Organization ID | -| `limit` | query | integer | false | Page limit, if 0 returns all members | -| `offset` | query | integer | false | Page offset | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| +|`limit`|query|integer|false|Page limit, if 0 returns all members| +|`offset`|query|integer|false|Page offset| ### Example responses @@ -898,32 +898,32 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/paginat ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.PaginatedMembersResponse](schemas.md#codersdkpaginatedmembersresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.PaginatedMembersResponse](schemas.md#codersdkpaginatedmembersresponse)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-----------------------|-------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» count` | integer | false | | | -| `» members` | array | false | | | -| `»» avatar_url` | string | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» email` | string | false | | | -| `»» global_roles` | array | false | | | -| `»»» display_name` | string | false | | | -| `»»» name` | string | false | | | -| `»»» organization_id` | string | false | | | -| `»» name` | string | false | | | -| `»» organization_id` | string(uuid) | false | | | -| `»» roles` | array | false | | | -| `»» updated_at` | string(date-time) | false | | | -| `»» user_id` | string(uuid) | false | | | -| `»» username` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» count`|integer|false||| +|`» members`|array|false||| +|`»» avatar_url`|string|false||| +|`»» created_at`|string(date-time)|false||| +|`»» email`|string|false||| +|`»» global_roles`|array|false||| +|`»»» display_name`|string|false||| +|`»»» name`|string|false||| +|`»»» organization_id`|string|false||| +|`»» name`|string|false||| +|`»» organization_id`|string(uuid)|false||| +|`»» roles`|array|false||| +|`»» updated_at`|string(date-time)|false||| +|`»» user_id`|string(uuid)|false||| +|`»» username`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -979,86 +979,86 @@ curl -X GET http://coder-server:8080/api/v2/users/roles \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» assignable` | boolean | false | | | -| `» built_in` | boolean | false | | Built in roles are immutable | -| `» display_name` | string | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» organization_permissions` | array | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. | -| `»» action` | [codersdk.RBACAction](schemas.md#codersdkrbacaction) | false | | | -| `»» negate` | boolean | false | | Negate makes this a negative permission | -| `»» resource_type` | [codersdk.RBACResource](schemas.md#codersdkrbacresource) | false | | | -| `» site_permissions` | array | false | | | -| `» user_permissions` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» assignable`|boolean|false||| +|`» built_in`|boolean|false||Built in roles are immutable| +|`» display_name`|string|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» organization_permissions`|array|false||Organization permissions are specific for the organization in the field 'OrganizationID' above.| +|`»» action`|[codersdk.RBACAction](schemas.md#codersdkrbacaction)|false||| +|`»» negate`|boolean|false||Negate makes this a negative permission| +|`»» resource_type`|[codersdk.RBACResource](schemas.md#codersdkrbacresource)|false||| +|`» site_permissions`|array|false||| +|`» user_permissions`|array|false||| #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `template` | -| `resource_type` | `user` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +|Property|Value| +|---|---| +|`action`|`application_connect`| +|`action`|`assign`| +|`action`|`create`| +|`action`|`create_agent`| +|`action`|`delete`| +|`action`|`delete_agent`| +|`action`|`read`| +|`action`|`read_personal`| +|`action`|`ssh`| +|`action`|`unassign`| +|`action`|`update`| +|`action`|`update_personal`| +|`action`|`use`| +|`action`|`view_insights`| +|`action`|`start`| +|`action`|`stop`| +|`resource_type`|`*`| +|`resource_type`|`api_key`| +|`resource_type`|`assign_org_role`| +|`resource_type`|`assign_role`| +|`resource_type`|`audit_log`| +|`resource_type`|`connection_log`| +|`resource_type`|`crypto_key`| +|`resource_type`|`debug_info`| +|`resource_type`|`deployment_config`| +|`resource_type`|`deployment_stats`| +|`resource_type`|`file`| +|`resource_type`|`group`| +|`resource_type`|`group_member`| +|`resource_type`|`idpsync_settings`| +|`resource_type`|`inbox_notification`| +|`resource_type`|`license`| +|`resource_type`|`notification_message`| +|`resource_type`|`notification_preference`| +|`resource_type`|`notification_template`| +|`resource_type`|`oauth2_app`| +|`resource_type`|`oauth2_app_code_token`| +|`resource_type`|`oauth2_app_secret`| +|`resource_type`|`organization`| +|`resource_type`|`organization_member`| +|`resource_type`|`prebuilt_workspace`| +|`resource_type`|`provisioner_daemon`| +|`resource_type`|`provisioner_jobs`| +|`resource_type`|`replicas`| +|`resource_type`|`system`| +|`resource_type`|`tailnet_coordinator`| +|`resource_type`|`template`| +|`resource_type`|`user`| +|`resource_type`|`webpush_subscription`| +|`resource_type`|`workspace`| +|`resource_type`|`workspace_agent_devcontainers`| +|`resource_type`|`workspace_agent_resource_monitor`| +|`resource_type`|`workspace_dormant`| +|`resource_type`|`workspace_proxy`| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/notifications.md b/docs/reference/api/notifications.md index 09890d3b17864..11ce7eb3899d5 100644 --- a/docs/reference/api/notifications.md +++ b/docs/reference/api/notifications.md @@ -30,19 +30,19 @@ curl -X GET http://coder-server:8080/api/v2/notifications/dispatch-methods \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationMethodsResponse](schemas.md#codersdknotificationmethodsresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.NotificationMethodsResponse](schemas.md#codersdknotificationmethodsresponse)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» available` | array | false | | | -| `» default` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» available`|array|false||| +|`» default`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -61,12 +61,12 @@ curl -X GET http://coder-server:8080/api/v2/notifications/inbox \ ### Parameters -| Name | In | Type | Required | Description | -|-------------------|-------|--------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `targets` | query | string | false | Comma-separated list of target IDs to filter notifications | -| `templates` | query | string | false | Comma-separated list of template IDs to filter notifications | -| `read_status` | query | string | false | Filter notifications by read status. Possible values: read, unread, all | -| `starting_before` | query | string(uuid) | false | ID of the last notification from the current page. Notifications returned will be older than the associated one | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`targets`|query|string|false|Comma-separated list of target IDs to filter notifications| +|`templates`|query|string|false|Comma-separated list of template IDs to filter notifications| +|`read_status`|query|string|false|Filter notifications by read status. Possible values: read, unread, all| +|`starting_before`|query|string(uuid)|false|ID of the last notification from the current page. Notifications returned will be older than the associated one| ### Example responses @@ -101,9 +101,9 @@ curl -X GET http://coder-server:8080/api/v2/notifications/inbox \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ListInboxNotificationsResponse](schemas.md#codersdklistinboxnotificationsresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ListInboxNotificationsResponse](schemas.md#codersdklistinboxnotificationsresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -121,9 +121,9 @@ curl -X PUT http://coder-server:8080/api/v2/notifications/inbox/mark-all-as-read ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -142,19 +142,19 @@ curl -X GET http://coder-server:8080/api/v2/notifications/inbox/watch \ ### Parameters -| Name | In | Type | Required | Description | -|---------------|-------|--------|----------|-------------------------------------------------------------------------| -| `targets` | query | string | false | Comma-separated list of target IDs to filter notifications | -| `templates` | query | string | false | Comma-separated list of template IDs to filter notifications | -| `read_status` | query | string | false | Filter notifications by read status. Possible values: read, unread, all | -| `format` | query | string | false | Define the output format for notifications title and body. | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`targets`|query|string|false|Comma-separated list of target IDs to filter notifications| +|`templates`|query|string|false|Comma-separated list of template IDs to filter notifications| +|`read_status`|query|string|false|Filter notifications by read status. Possible values: read, unread, all| +|`format`|query|string|false|Define the output format for notifications title and body.| #### Enumerated Values -| Parameter | Value | -|-----------|-------------| -| `format` | `plaintext` | -| `format` | `markdown` | +|Parameter|Value| +|---|---| +|`format`|`plaintext`| +|`format`|`markdown`| ### Example responses @@ -187,9 +187,9 @@ curl -X GET http://coder-server:8080/api/v2/notifications/inbox/watch \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GetInboxNotificationResponse](schemas.md#codersdkgetinboxnotificationresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GetInboxNotificationResponse](schemas.md#codersdkgetinboxnotificationresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -208,9 +208,9 @@ curl -X PUT http://coder-server:8080/api/v2/notifications/inbox/{id}/read-status ### Parameters -| Name | In | Type | Required | Description | -|------|------|--------|----------|------------------------| -| `id` | path | string | true | id of the notification | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`id`|path|string|true|id of the notification| ### Example responses @@ -231,9 +231,9 @@ curl -X PUT http://coder-server:8080/api/v2/notifications/inbox/{id}/read-status ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -262,9 +262,9 @@ curl -X GET http://coder-server:8080/api/v2/notifications/settings \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -292,9 +292,9 @@ curl -X PUT http://coder-server:8080/api/v2/notifications/settings \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------|----------|--------------------------------| -| `body` | body | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) | true | Notifications settings request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings)|true|Notifications settings request| ### Example responses @@ -308,10 +308,10 @@ curl -X PUT http://coder-server:8080/api/v2/notifications/settings \ ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|--------------|----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) | -| 304 | [Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1) | Not Modified | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings)| +|304|[Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1)|Not Modified|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -350,26 +350,26 @@ curl -X GET http://coder-server:8080/api/v2/notifications/templates/system \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationTemplate](schemas.md#codersdknotificationtemplate) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.NotificationTemplate](schemas.md#codersdknotificationtemplate)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------------|--------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» actions` | string | false | | | -| `» body_template` | string | false | | | -| `» enabled_by_default` | boolean | false | | | -| `» group` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» kind` | string | false | | | -| `» method` | string | false | | | -| `» name` | string | false | | | -| `» title_template` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» actions`|string|false||| +|`» body_template`|string|false||| +|`» enabled_by_default`|boolean|false||| +|`» group`|string|false||| +|`» id`|string(uuid)|false||| +|`» kind`|string|false||| +|`» method`|string|false||| +|`» name`|string|false||| +|`» title_template`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -387,9 +387,9 @@ curl -X POST http://coder-server:8080/api/v2/notifications/test \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -408,9 +408,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/notifications/preferenc ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -428,20 +428,20 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/notifications/preferenc ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationPreference](schemas.md#codersdknotificationpreference) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.NotificationPreference](schemas.md#codersdknotificationpreference)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|-------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» disabled` | boolean | false | | | -| `» id` | string(uuid) | false | | | -| `» updated_at` | string(date-time) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» disabled`|boolean|false||| +|`» id`|string(uuid)|false||| +|`» updated_at`|string(date-time)|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -472,10 +472,10 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/notifications/preferenc ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------------------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `body` | body | [codersdk.UpdateUserNotificationPreferences](schemas.md#codersdkupdateusernotificationpreferences) | true | Preferences | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`body`|body|[codersdk.UpdateUserNotificationPreferences](schemas.md#codersdkupdateusernotificationpreferences)|true|Preferences| ### Example responses @@ -493,19 +493,19 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/notifications/preferenc ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationPreference](schemas.md#codersdknotificationpreference) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.NotificationPreference](schemas.md#codersdknotificationpreference)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|-------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» disabled` | boolean | false | | | -| `» id` | string(uuid) | false | | | -| `» updated_at` | string(date-time) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» disabled`|boolean|false||| +|`» id`|string(uuid)|false||| +|`» updated_at`|string(date-time)|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/organizations.md b/docs/reference/api/organizations.md index 497e3f56d4e47..427e968ea154f 100644 --- a/docs/reference/api/organizations.md +++ b/docs/reference/api/organizations.md @@ -24,9 +24,9 @@ curl -X POST http://coder-server:8080/api/v2/licenses \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------|----------|---------------------| -| `body` | body | [codersdk.AddLicenseRequest](schemas.md#codersdkaddlicenserequest) | true | Add license request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.AddLicenseRequest](schemas.md#codersdkaddlicenserequest)|true|Add license request| ### Example responses @@ -43,9 +43,9 @@ curl -X POST http://coder-server:8080/api/v2/licenses \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.License](schemas.md#codersdklicense) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.License](schemas.md#codersdklicense)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -81,9 +81,9 @@ curl -X POST http://coder-server:8080/api/v2/licenses/refresh-entitlements \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|--------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -121,25 +121,25 @@ curl -X GET http://coder-server:8080/api/v2/organizations \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Organization](schemas.md#codersdkorganization) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Organization](schemas.md#codersdkorganization)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------|-------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | true | | | -| `» description` | string | false | | | -| `» display_name` | string | false | | | -| `» icon` | string | false | | | -| `» id` | string(uuid) | true | | | -| `» is_default` | boolean | true | | | -| `» name` | string | false | | | -| `» updated_at` | string(date-time) | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|true||| +|`» description`|string|false||| +|`» display_name`|string|false||| +|`» icon`|string|false||| +|`» id`|string(uuid)|true||| +|`» is_default`|boolean|true||| +|`» name`|string|false||| +|`» updated_at`|string(date-time)|true||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -170,9 +170,9 @@ curl -X POST http://coder-server:8080/api/v2/organizations \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------------|----------|-----------------------------| -| `body` | body | [codersdk.CreateOrganizationRequest](schemas.md#codersdkcreateorganizationrequest) | true | Create organization request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.CreateOrganizationRequest](schemas.md#codersdkcreateorganizationrequest)|true|Create organization request| ### Example responses @@ -193,9 +193,9 @@ curl -X POST http://coder-server:8080/api/v2/organizations \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|----------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Organization](schemas.md#codersdkorganization) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.Organization](schemas.md#codersdkorganization)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -214,9 +214,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization} \ ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -237,9 +237,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Organization](schemas.md#codersdkorganization)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -258,9 +258,9 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization} \ ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------|----------|-------------------------| -| `organization` | path | string | true | Organization ID or name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID or name| ### Example responses @@ -281,9 +281,9 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -314,10 +314,10 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization} \ ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|------------------------------------------------------------------------------------|----------|----------------------------| -| `organization` | path | string | true | Organization ID or name | -| `body` | body | [codersdk.UpdateOrganizationRequest](schemas.md#codersdkupdateorganizationrequest) | true | Patch organization request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID or name| +|`body`|body|[codersdk.UpdateOrganizationRequest](schemas.md#codersdkupdateorganizationrequest)|true|Patch organization request| ### Example responses @@ -338,9 +338,9 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Organization](schemas.md#codersdkorganization)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -359,31 +359,31 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|--------------|----------|------------------------------------------------------------------------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `limit` | query | integer | false | Page limit | -| `ids` | query | array(uuid) | false | Filter results by job IDs | -| `status` | query | string | false | Filter results by status | -| `tags` | query | object | false | Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'}) | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`limit`|query|integer|false|Page limit| +|`ids`|query|array(uuid)|false|Filter results by job IDs| +|`status`|query|string|false|Filter results by status| +|`tags`|query|object|false|Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})| #### Enumerated Values -| Parameter | Value | -|-----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `status` | `unknown` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | +|Parameter|Value| +|---|---| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| +|`status`|`unknown`| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| ### Example responses @@ -434,62 +434,62 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------------------|------------------------------------------------------------------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» available_workers` | array | false | | | -| `» canceled_at` | string(date-time) | false | | | -| `» completed_at` | string(date-time) | false | | | -| `» created_at` | string(date-time) | false | | | -| `» error` | string | false | | | -| `» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | | -| `» file_id` | string(uuid) | false | | | -| `» id` | string(uuid) | false | | | -| `» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | | -| `»» error` | string | false | | | -| `»» template_version_id` | string(uuid) | false | | | -| `»» workspace_build_id` | string(uuid) | false | | | -| `» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | | -| `»» template_display_name` | string | false | | | -| `»» template_icon` | string | false | | | -| `»» template_id` | string(uuid) | false | | | -| `»» template_name` | string | false | | | -| `»» template_version_name` | string | false | | | -| `»» workspace_id` | string(uuid) | false | | | -| `»» workspace_name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» queue_position` | integer | false | | | -| `» queue_size` | integer | false | | | -| `» started_at` | string(date-time) | false | | | -| `» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | | -| `» tags` | object | false | | | -| `»» [any property]` | string | false | | | -| `» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | | -| `» worker_id` | string(uuid) | false | | | -| `» worker_name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» available_workers`|array|false||| +|`» canceled_at`|string(date-time)|false||| +|`» completed_at`|string(date-time)|false||| +|`» created_at`|string(date-time)|false||| +|`» error`|string|false||| +|`» error_code`|[codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode)|false||| +|`» file_id`|string(uuid)|false||| +|`» id`|string(uuid)|false||| +|`» input`|[codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput)|false||| +|`»» error`|string|false||| +|`»» template_version_id`|string(uuid)|false||| +|`»» workspace_build_id`|string(uuid)|false||| +|`» metadata`|[codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata)|false||| +|`»» template_display_name`|string|false||| +|`»» template_icon`|string|false||| +|`»» template_id`|string(uuid)|false||| +|`»» template_name`|string|false||| +|`»» template_version_name`|string|false||| +|`»» workspace_id`|string(uuid)|false||| +|`»» workspace_name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» queue_position`|integer|false||| +|`» queue_size`|integer|false||| +|`» started_at`|string(date-time)|false||| +|`» status`|[codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus)|false||| +|`» tags`|object|false||| +|`»» [any property]`|string|false||| +|`» type`|[codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype)|false||| +|`» worker_id`|string(uuid)|false||| +|`» worker_name`|string|false||| #### Enumerated Values -| Property | Value | -|--------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `type` | `template_version_import` | -| `type` | `workspace_build` | -| `type` | `template_version_dry_run` | +|Property|Value| +|---|---| +|`error_code`|`REQUIRED_TEMPLATE_VARIABLES`| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| +|`type`|`template_version_import`| +|`type`|`workspace_build`| +|`type`|`template_version_dry_run`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -508,10 +508,10 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `job` | path | string(uuid) | true | Job ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`job`|path|string(uuid)|true|Job ID| ### Example responses @@ -560,8 +560,8 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/portsharing.md b/docs/reference/api/portsharing.md index d143e5e2ea14a..d6230971707ba 100644 --- a/docs/reference/api/portsharing.md +++ b/docs/reference/api/portsharing.md @@ -15,9 +15,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------|----------|--------------| -| `workspace` | path | string(uuid) | true | Workspace ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| ### Example responses @@ -39,9 +39,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentPortShares](schemas.md#codersdkworkspaceagentportshares) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceAgentPortShares](schemas.md#codersdkworkspaceagentportshares)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -72,10 +72,10 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|----------------------------------------------------------------------------------------------------------|----------|-----------------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.UpsertWorkspaceAgentPortShareRequest](schemas.md#codersdkupsertworkspaceagentportsharerequest) | true | Upsert port sharing level request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.UpsertWorkspaceAgentPortShareRequest](schemas.md#codersdkupsertworkspaceagentportsharerequest)|true|Upsert port sharing level request| ### Example responses @@ -93,9 +93,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentPortShare](schemas.md#codersdkworkspaceagentportshare) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceAgentPortShare](schemas.md#codersdkworkspaceagentportshare)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -123,15 +123,15 @@ curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/port-share ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|----------------------------------------------------------------------------------------------------------|----------|-----------------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.DeleteWorkspaceAgentPortShareRequest](schemas.md#codersdkdeleteworkspaceagentportsharerequest) | true | Delete port sharing level request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.DeleteWorkspaceAgentPortShareRequest](schemas.md#codersdkdeleteworkspaceagentportsharerequest)|true|Delete port sharing level request| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/prebuilds.md b/docs/reference/api/prebuilds.md index 117e06d8c6317..72b32d68aa1a5 100644 --- a/docs/reference/api/prebuilds.md +++ b/docs/reference/api/prebuilds.md @@ -25,9 +25,9 @@ curl -X GET http://coder-server:8080/api/v2/prebuilds/settings \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.PrebuildsSettings](schemas.md#codersdkprebuildssettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.PrebuildsSettings](schemas.md#codersdkprebuildssettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -55,9 +55,9 @@ curl -X PUT http://coder-server:8080/api/v2/prebuilds/settings \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------|----------|----------------------------| -| `body` | body | [codersdk.PrebuildsSettings](schemas.md#codersdkprebuildssettings) | true | Prebuilds settings request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.PrebuildsSettings](schemas.md#codersdkprebuildssettings)|true|Prebuilds settings request| ### Example responses @@ -71,9 +71,9 @@ curl -X PUT http://coder-server:8080/api/v2/prebuilds/settings \ ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|--------------|--------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.PrebuildsSettings](schemas.md#codersdkprebuildssettings) | -| 304 | [Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1) | Not Modified | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.PrebuildsSettings](schemas.md#codersdkprebuildssettings)| +|304|[Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1)|Not Modified|| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/provisioning.md b/docs/reference/api/provisioning.md index 1d910e4bc045e..780a11636f52c 100644 --- a/docs/reference/api/provisioning.md +++ b/docs/reference/api/provisioning.md @@ -15,31 +15,31 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|--------------|----------|------------------------------------------------------------------------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `limit` | query | integer | false | Page limit | -| `ids` | query | array(uuid) | false | Filter results by job IDs | -| `status` | query | string | false | Filter results by status | -| `tags` | query | object | false | Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'}) | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`limit`|query|integer|false|Page limit| +|`ids`|query|array(uuid)|false|Filter results by job IDs| +|`status`|query|string|false|Filter results by status| +|`tags`|query|object|false|Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})| #### Enumerated Values -| Parameter | Value | -|-----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `status` | `unknown` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | +|Parameter|Value| +|---|---| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| +|`status`|`unknown`| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| ### Example responses @@ -85,50 +85,50 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerDaemon](schemas.md#codersdkprovisionerdaemon) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.ProvisionerDaemon](schemas.md#codersdkprovisionerdaemon)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------------------|--------------------------------------------------------------------------------|----------|--------------|------------------| -| `[array item]` | array | false | | | -| `» api_version` | string | false | | | -| `» created_at` | string(date-time) | false | | | -| `» current_job` | [codersdk.ProvisionerDaemonJob](schemas.md#codersdkprovisionerdaemonjob) | false | | | -| `»» id` | string(uuid) | false | | | -| `»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | | -| `»» template_display_name` | string | false | | | -| `»» template_icon` | string | false | | | -| `»» template_name` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» key_id` | string(uuid) | false | | | -| `» key_name` | string | false | | Optional fields. | -| `» last_seen_at` | string(date-time) | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» previous_job` | [codersdk.ProvisionerDaemonJob](schemas.md#codersdkprovisionerdaemonjob) | false | | | -| `» provisioners` | array | false | | | -| `» status` | [codersdk.ProvisionerDaemonStatus](schemas.md#codersdkprovisionerdaemonstatus) | false | | | -| `» tags` | object | false | | | -| `»» [any property]` | string | false | | | -| `» version` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» api_version`|string|false||| +|`» created_at`|string(date-time)|false||| +|`» current_job`|[codersdk.ProvisionerDaemonJob](schemas.md#codersdkprovisionerdaemonjob)|false||| +|`»» id`|string(uuid)|false||| +|`»» status`|[codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus)|false||| +|`»» template_display_name`|string|false||| +|`»» template_icon`|string|false||| +|`»» template_name`|string|false||| +|`» id`|string(uuid)|false||| +|`» key_id`|string(uuid)|false||| +|`» key_name`|string|false||Optional fields.| +|`» last_seen_at`|string(date-time)|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» previous_job`|[codersdk.ProvisionerDaemonJob](schemas.md#codersdkprovisionerdaemonjob)|false||| +|`» provisioners`|array|false||| +|`» status`|[codersdk.ProvisionerDaemonStatus](schemas.md#codersdkprovisionerdaemonstatus)|false||| +|`» tags`|object|false||| +|`»» [any property]`|string|false||| +|`» version`|string|false||| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `status` | `offline` | -| `status` | `idle` | -| `status` | `busy` | +|Property|Value| +|---|---| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| +|`status`|`offline`| +|`status`|`idle`| +|`status`|`busy`| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md index e41c4c093cc4d..15e251b4e8a37 100644 --- a/docs/reference/api/schemas.md +++ b/docs/reference/api/schemas.md @@ -11,10 +11,10 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|--------|----------|--------------|-------------| -| `document` | string | true | | | -| `signature` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`document`|string|true||| +|`signature`|string|true||| ## agentsdk.AuthenticateResponse @@ -26,9 +26,9 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|--------|----------|--------------|-------------| -| `session_token` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`session_token`|string|false||| ## agentsdk.AzureInstanceIdentityToken @@ -41,10 +41,10 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|--------|----------|--------------|-------------| -| `encoding` | string | true | | | -| `signature` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`encoding`|string|true||| +|`signature`|string|true||| ## agentsdk.ExternalAuthResponse @@ -61,14 +61,14 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|------------------------------------------------------------------------------------------| -| `access_token` | string | false | | | -| `password` | string | false | | | -| `token_extra` | object | false | | | -| `type` | string | false | | | -| `url` | string | false | | | -| `username` | string | false | | Deprecated: Only supported on `/workspaceagents/me/gitauth` for backwards compatibility. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`access_token`|string|false||| +|`password`|string|false||| +|`token_extra`|object|false||| +|`type`|string|false||| +|`url`|string|false||| +|`username`|string|false||Deprecated: Only supported on `/workspaceagents/me/gitauth` for backwards compatibility.| ## agentsdk.GitSSHKey @@ -81,10 +81,10 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|--------|----------|--------------|-------------| -| `private_key` | string | false | | | -| `public_key` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`private_key`|string|false||| +|`public_key`|string|false||| ## agentsdk.GoogleInstanceIdentityToken @@ -96,9 +96,9 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|--------|----------|--------------|-------------| -| `json_web_token` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`json_web_token`|string|true||| ## agentsdk.Log @@ -112,11 +112,11 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|----------------------------------------|----------|--------------|-------------| -| `created_at` | string | false | | | -| `level` | [codersdk.LogLevel](#codersdkloglevel) | false | | | -| `output` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|false||| +|`level`|[codersdk.LogLevel](#codersdkloglevel)|false||| +|`output`|string|false||| ## agentsdk.PatchAppStatus @@ -133,14 +133,14 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|----------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------| -| `app_slug` | string | false | | | -| `icon` | string | false | | Deprecated: this field is unused and will be removed in a future version. | -| `message` | string | false | | | -| `needs_user_attention` | boolean | false | | Deprecated: this field is unused and will be removed in a future version. | -| `state` | [codersdk.WorkspaceAppStatusState](#codersdkworkspaceappstatusstate) | false | | | -| `uri` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`app_slug`|string|false||| +|`icon`|string|false||Deprecated: this field is unused and will be removed in a future version.| +|`message`|string|false||| +|`needs_user_attention`|boolean|false||Deprecated: this field is unused and will be removed in a future version.| +|`state`|[codersdk.WorkspaceAppStatusState](#codersdkworkspaceappstatusstate)|false||| +|`uri`|string|false||| ## agentsdk.PatchLogs @@ -159,10 +159,10 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|---------------------------------------|----------|--------------|-------------| -| `log_source_id` | string | false | | | -| `logs` | array of [agentsdk.Log](#agentsdklog) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`log_source_id`|string|false||| +|`logs`|array of [agentsdk.Log](#agentsdklog)|false||| ## agentsdk.PostLogSourceRequest @@ -176,11 +176,11 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `display_name` | string | false | | | -| `icon` | string | false | | | -| `id` | string | false | | ID is a unique identifier for the log source. It is scoped to a workspace agent, and can be statically defined inside code to prevent duplicate sources from being created for the same agent. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|false||| +|`icon`|string|false||| +|`id`|string|false||ID is a unique identifier for the log source. It is scoped to a workspace agent, and can be statically defined inside code to prevent duplicate sources from being created for the same agent.| ## agentsdk.ReinitializationEvent @@ -193,10 +193,10 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|--------------------------------------------------------------------|----------|--------------|-------------| -| `reason` | [agentsdk.ReinitializationReason](#agentsdkreinitializationreason) | false | | | -| `workspaceID` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`reason`|[agentsdk.ReinitializationReason](#agentsdkreinitializationreason)|false||| +|`workspaceID`|string|false||| ## agentsdk.ReinitializationReason @@ -208,9 +208,9 @@ #### Enumerated Values -| Value | -|--------------------| -| `prebuild_claimed` | +|Value| +|---| +|`prebuild_claimed`| ## coderd.SCIMUser @@ -245,23 +245,23 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|--------------------|----------|--------------|-----------------------------------------------------------------------------| -| `active` | boolean | false | | Active is a ptr to prevent the empty value from being interpreted as 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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`active`|boolean|false||Active is a ptr to prevent the empty value from being interpreted as 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||| ## coderd.cspViolation @@ -273,9 +273,9 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|--------|----------|--------------|-------------| -| `csp-report` | object | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`csp-report`|object|false||| ## codersdk.ACLAvailable @@ -330,10 +330,10 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|-------------------------------------------------------|----------|--------------|-------------| -| `groups` | array of [codersdk.Group](#codersdkgroup) | false | | | -| `users` | array of [codersdk.ReducedUser](#codersdkreduceduser) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`groups`|array of [codersdk.Group](#codersdkgroup)|false||| +|`users`|array of [codersdk.ReducedUser](#codersdkreduceduser)|false||| ## codersdk.APIKey @@ -354,29 +354,29 @@ ### Properties -| 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 | | | -| `token_name` | string | true | | | -| `updated_at` | string | true | | | -| `user_id` | string | true | | | +|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||| +|`token_name`|string|true||| +|`updated_at`|string|true||| +|`user_id`|string|true||| #### Enumerated Values -| Property | Value | -|--------------|-----------------------| -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `scope` | `all` | -| `scope` | `application_connect` | +|Property|Value| +|---|---| +|`login_type`|`password`| +|`login_type`|`github`| +|`login_type`|`oidc`| +|`login_type`|`token`| +|`scope`|`all`| +|`scope`|`application_connect`| ## codersdk.APIKeyScope @@ -388,10 +388,10 @@ #### Enumerated Values -| Value | -|-----------------------| -| `all` | -| `application_connect` | +|Value| +|---| +|`all`| +|`application_connect`| ## codersdk.AddLicenseRequest @@ -403,9 +403,9 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|--------|----------|--------------|-------------| -| `license` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`license`|string|true||| ## codersdk.AgentConnectionTiming @@ -421,13 +421,13 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|----------------------------------------------|----------|--------------|-------------| -| `ended_at` | string | false | | | -| `stage` | [codersdk.TimingStage](#codersdktimingstage) | false | | | -| `started_at` | string | false | | | -| `workspace_agent_id` | string | false | | | -| `workspace_agent_name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`ended_at`|string|false||| +|`stage`|[codersdk.TimingStage](#codersdktimingstage)|false||| +|`started_at`|string|false||| +|`workspace_agent_id`|string|false||| +|`workspace_agent_name`|string|false||| ## codersdk.AgentScriptTiming @@ -446,16 +446,16 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|----------------------------------------------|----------|--------------|-------------| -| `display_name` | string | false | | | -| `ended_at` | string | false | | | -| `exit_code` | integer | false | | | -| `stage` | [codersdk.TimingStage](#codersdktimingstage) | false | | | -| `started_at` | string | false | | | -| `status` | string | false | | | -| `workspace_agent_id` | string | false | | | -| `workspace_agent_name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|false||| +|`ended_at`|string|false||| +|`exit_code`|integer|false||| +|`stage`|[codersdk.TimingStage](#codersdktimingstage)|false||| +|`started_at`|string|false||| +|`status`|string|false||| +|`workspace_agent_id`|string|false||| +|`workspace_agent_name`|string|false||| ## codersdk.AgentSubsystem @@ -467,11 +467,11 @@ #### Enumerated Values -| Value | -|--------------| -| `envbox` | -| `envbuilder` | -| `exectrace` | +|Value| +|---| +|`envbox`| +|`envbuilder`| +|`exectrace`| ## codersdk.AppHostResponse @@ -483,9 +483,9 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|--------|--------|----------|--------------|---------------------------------------------------------------| -| `host` | string | false | | Host is the externally accessible URL for the Coder instance. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`host`|string|false||Host is the externally accessible URL for the Coder instance.| ## codersdk.AppearanceConfig @@ -518,14 +518,14 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|---------------------------------------------------------|----------|--------------|---------------------------------------------------------------------| -| `announcement_banners` | array of [codersdk.BannerConfig](#codersdkbannerconfig) | false | | | -| `application_name` | string | false | | | -| `docs_url` | string | false | | | -| `logo_url` | string | false | | | -| `service_banner` | [codersdk.BannerConfig](#codersdkbannerconfig) | false | | Deprecated: ServiceBanner has been replaced by AnnouncementBanners. | -| `support_links` | array of [codersdk.LinkConfig](#codersdklinkconfig) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`announcement_banners`|array of [codersdk.BannerConfig](#codersdkbannerconfig)|false||| +|`application_name`|string|false||| +|`docs_url`|string|false||| +|`logo_url`|string|false||| +|`service_banner`|[codersdk.BannerConfig](#codersdkbannerconfig)|false||Deprecated: ServiceBanner has been replaced by AnnouncementBanners.| +|`support_links`|array of [codersdk.LinkConfig](#codersdklinkconfig)|false||| ## codersdk.ArchiveTemplateVersionsRequest @@ -537,9 +537,9 @@ ### 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. | +|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.| ## codersdk.AssignableRoles @@ -576,16 +576,16 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------------|-----------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------| -| `assignable` | boolean | false | | | -| `built_in` | boolean | false | | Built in roles are immutable | -| `display_name` | string | false | | | -| `name` | string | false | | | -| `organization_id` | string | false | | | -| `organization_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. | -| `site_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | | -| `user_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`assignable`|boolean|false||| +|`built_in`|boolean|false||Built in roles are immutable| +|`display_name`|string|false||| +|`name`|string|false||| +|`organization_id`|string|false||| +|`organization_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||Organization permissions are specific for the organization in the field 'OrganizationID' above.| +|`site_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||| +|`user_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||| ## codersdk.AuditAction @@ -597,21 +597,21 @@ #### Enumerated Values -| Value | -|--------------------------| -| `create` | -| `write` | -| `delete` | -| `start` | -| `stop` | -| `login` | -| `logout` | -| `register` | -| `request_password_reset` | -| `connect` | -| `disconnect` | -| `open` | -| `close` | +|Value| +|---| +|`create`| +|`write`| +|`delete`| +|`start`| +|`stop`| +|`login`| +|`logout`| +|`register`| +|`request_password_reset`| +|`connect`| +|`disconnect`| +|`open`| +|`close`| ## codersdk.AuditDiff @@ -632,9 +632,9 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|----------------------------------------------------|----------|--------------|-------------| -| `[any property]` | [codersdk.AuditDiffField](#codersdkauditdifffield) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[any property]`|[codersdk.AuditDiffField](#codersdkauditdifffield)|false||| ## codersdk.AuditDiffField @@ -648,11 +648,11 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|---------|----------|--------------|-------------| -| `new` | any | false | | | -| `old` | any | false | | | -| `secret` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`new`|any|false||| +|`old`|any|false||| +|`secret`|boolean|false||| ## codersdk.AuditLog @@ -720,27 +720,27 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|--------------------------------------------------------------|----------|--------------|----------------------------------------------| -| `action` | [codersdk.AuditAction](#codersdkauditaction) | false | | | -| `additional_fields` | object | false | | | -| `description` | string | false | | | -| `diff` | [codersdk.AuditDiff](#codersdkauditdiff) | false | | | -| `id` | string | false | | | -| `ip` | string | false | | | -| `is_deleted` | boolean | false | | | -| `organization` | [codersdk.MinimalOrganization](#codersdkminimalorganization) | false | | | -| `organization_id` | string | false | | Deprecated: Use 'organization.id' instead. | -| `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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`action`|[codersdk.AuditAction](#codersdkauditaction)|false||| +|`additional_fields`|object|false||| +|`description`|string|false||| +|`diff`|[codersdk.AuditDiff](#codersdkauditdiff)|false||| +|`id`|string|false||| +|`ip`|string|false||| +|`is_deleted`|boolean|false||| +|`organization`|[codersdk.MinimalOrganization](#codersdkminimalorganization)|false||| +|`organization_id`|string|false||Deprecated: Use 'organization.id' instead.| +|`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||| ## codersdk.AuditLogResponse @@ -813,10 +813,10 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|-------------------------------------------------|----------|--------------|-------------| -| `audit_logs` | array of [codersdk.AuditLog](#codersdkauditlog) | false | | | -| `count` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`audit_logs`|array of [codersdk.AuditLog](#codersdkauditlog)|false||| +|`count`|integer|false||| ## codersdk.AuthMethod @@ -828,9 +828,9 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|---------|----------|--------------|-------------| -| `enabled` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`enabled`|boolean|false||| ## codersdk.AuthMethods @@ -854,12 +854,12 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|--------------------------------------------------------|----------|--------------|-------------| -| `github` | [codersdk.GithubAuthMethod](#codersdkgithubauthmethod) | false | | | -| `oidc` | [codersdk.OIDCAuthMethod](#codersdkoidcauthmethod) | false | | | -| `password` | [codersdk.AuthMethod](#codersdkauthmethod) | false | | | -| `terms_of_service_url` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`github`|[codersdk.GithubAuthMethod](#codersdkgithubauthmethod)|false||| +|`oidc`|[codersdk.OIDCAuthMethod](#codersdkoidcauthmethod)|false||| +|`password`|[codersdk.AuthMethod](#codersdkauthmethod)|false||| +|`terms_of_service_url`|string|false||| ## codersdk.AuthorizationCheck @@ -880,19 +880,19 @@ AuthorizationCheck is used to check if the currently authenticated user (or the ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|--------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `action` | [codersdk.RBACAction](#codersdkrbacaction) | 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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`action`|[codersdk.RBACAction](#codersdkrbacaction)|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.| #### Enumerated Values -| Property | Value | -|----------|----------| -| `action` | `create` | -| `action` | `read` | -| `action` | `update` | -| `action` | `delete` | +|Property|Value| +|---|---| +|`action`|`create`| +|`action`|`read`| +|`action`|`update`| +|`action`|`delete`| ## codersdk.AuthorizationObject @@ -910,13 +910,13 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------|------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `any_org` | boolean | false | | Any org (optional) will disregard the org_owner when checking for permissions. This cannot be set to true if the OrganizationID is set. | -| `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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`any_org`|boolean|false||Any org (optional) will disregard the org_owner when checking for permissions. This cannot be set to true if the OrganizationID is set.| +|`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.| ## codersdk.AuthorizationRequest @@ -949,10 +949,10 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### 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. | +|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 @@ -965,9 +965,9 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|---------|----------|--------------|-------------| -| `[any property]` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[any property]`|boolean|false||| ## codersdk.AutomaticUpdates @@ -979,10 +979,10 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in #### Enumerated Values -| Value | -|----------| -| `always` | -| `never` | +|Value| +|---| +|`always`| +|`never`| ## codersdk.BannerConfig @@ -996,11 +996,11 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------|----------|--------------|-------------| -| `background_color` | string | false | | | -| `enabled` | boolean | false | | | -| `message` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`background_color`|string|false||| +|`enabled`|boolean|false||| +|`message`|string|false||| ## codersdk.BuildInfoResponse @@ -1021,18 +1021,18 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| 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. | -| `deployment_id` | string | false | | Deployment ID is the unique identifier for this deployment. | -| `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. | -| `provisioner_api_version` | string | false | | Provisioner api version is the current version of the Provisioner API | -| `telemetry` | boolean | false | | Telemetry is a boolean that indicates whether telemetry is enabled. | -| `upgrade_message` | string | false | | Upgrade message is the message displayed to users when an outdated client is detected. | -| `version` | string | false | | Version returns the semantic version of the build. | -| `webpush_public_key` | string | false | | Webpush public key is the public key for push notifications via Web Push. | -| `workspace_proxy` | boolean | false | | | +|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.| +|`deployment_id`|string|false||Deployment ID is the unique identifier for this deployment.| +|`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.| +|`provisioner_api_version`|string|false||Provisioner api version is the current version of the Provisioner API| +|`telemetry`|boolean|false||Telemetry is a boolean that indicates whether telemetry is enabled.| +|`upgrade_message`|string|false||Upgrade message is the message displayed to users when an outdated client is detected.| +|`version`|string|false||Version returns the semantic version of the build.| +|`webpush_public_key`|string|false||Webpush public key is the public key for push notifications via Web Push.| +|`workspace_proxy`|boolean|false||| ## codersdk.BuildReason @@ -1044,17 +1044,17 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in #### Enumerated Values -| Value | -|------------------------| -| `initiator` | -| `autostart` | -| `autostop` | -| `dormancy` | -| `dashboard` | -| `cli` | -| `ssh_connection` | -| `vscode_connection` | -| `jetbrains_connection` | +|Value| +|---| +|`initiator`| +|`autostart`| +|`autostop`| +|`dormancy`| +|`dashboard`| +|`cli`| +|`ssh_connection`| +|`vscode_connection`| +|`jetbrains_connection`| ## codersdk.ChangePasswordWithOneTimePasscodeRequest @@ -1068,11 +1068,11 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|--------|----------|--------------|-------------| -| `email` | string | true | | | -| `one_time_passcode` | string | true | | | -| `password` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`email`|string|true||| +|`one_time_passcode`|string|true||| +|`password`|string|true||| ## codersdk.ConnectionLatency @@ -1085,10 +1085,10 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|-------|--------|----------|--------------|-------------| -| `p50` | number | false | | | -| `p95` | number | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`p50`|number|false||| +|`p95`|number|false||| ## codersdk.ConnectionLog @@ -1148,20 +1148,20 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------------|----------------------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `agent_name` | string | false | | | -| `connect_time` | string | false | | | -| `id` | string | false | | | -| `ip` | string | false | | | -| `organization` | [codersdk.MinimalOrganization](#codersdkminimalorganization) | false | | | -| `ssh_info` | [codersdk.ConnectionLogSSHInfo](#codersdkconnectionlogsshinfo) | false | | Ssh info is only set when `type` is one of: - `ConnectionTypeSSH` - `ConnectionTypeReconnectingPTY` - `ConnectionTypeVSCode` - `ConnectionTypeJetBrains` | -| `type` | [codersdk.ConnectionType](#codersdkconnectiontype) | false | | | -| `web_info` | [codersdk.ConnectionLogWebInfo](#codersdkconnectionlogwebinfo) | false | | Web info is only set when `type` is one of: - `ConnectionTypePortForwarding` - `ConnectionTypeWorkspaceApp` | -| `workspace_id` | string | false | | | -| `workspace_name` | string | false | | | -| `workspace_owner_id` | string | false | | | -| `workspace_owner_username` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`agent_name`|string|false||| +|`connect_time`|string|false||| +|`id`|string|false||| +|`ip`|string|false||| +|`organization`|[codersdk.MinimalOrganization](#codersdkminimalorganization)|false||| +|`ssh_info`|[codersdk.ConnectionLogSSHInfo](#codersdkconnectionlogsshinfo)|false||Ssh info is only set when `type` is one of: - `ConnectionTypeSSH` - `ConnectionTypeReconnectingPTY` - `ConnectionTypeVSCode` - `ConnectionTypeJetBrains`| +|`type`|[codersdk.ConnectionType](#codersdkconnectiontype)|false||| +|`web_info`|[codersdk.ConnectionLogWebInfo](#codersdkconnectionlogwebinfo)|false||Web info is only set when `type` is one of: - `ConnectionTypePortForwarding` - `ConnectionTypeWorkspaceApp`| +|`workspace_id`|string|false||| +|`workspace_name`|string|false||| +|`workspace_owner_id`|string|false||| +|`workspace_owner_username`|string|false||| ## codersdk.ConnectionLogResponse @@ -1226,10 +1226,10 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------|-----------------------------------------------------------|----------|--------------|-------------| -| `connection_logs` | array of [codersdk.ConnectionLog](#codersdkconnectionlog) | false | | | -| `count` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`connection_logs`|array of [codersdk.ConnectionLog](#codersdkconnectionlog)|false||| +|`count`|integer|false||| ## codersdk.ConnectionLogSSHInfo @@ -1244,12 +1244,12 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|---------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------| -| `connection_id` | string | false | | | -| `disconnect_reason` | string | false | | Disconnect reason is omitted if a disconnect event with the same connection ID has not yet been seen. | -| `disconnect_time` | string | false | | Disconnect time is omitted if a disconnect event with the same connection ID has not yet been seen. | -| `exit_code` | integer | false | | Exit code is the exit code of the SSH session. It is omitted if a disconnect event with the same connection ID has not yet been seen. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`connection_id`|string|false||| +|`disconnect_reason`|string|false||Disconnect reason is omitted if a disconnect event with the same connection ID has not yet been seen.| +|`disconnect_time`|string|false||Disconnect time is omitted if a disconnect event with the same connection ID has not yet been seen.| +|`exit_code`|integer|false||Exit code is the exit code of the SSH session. It is omitted if a disconnect event with the same connection ID has not yet been seen.| ## codersdk.ConnectionLogWebInfo @@ -1286,12 +1286,12 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------------------------------|----------|--------------|---------------------------------------------------------------------------| -| `slug_or_port` | string | false | | | -| `status_code` | integer | false | | Status code is the HTTP status code of the request. | -| `user` | [codersdk.User](#codersdkuser) | false | | User is omitted if the connection event was from an unauthenticated user. | -| `user_agent` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`slug_or_port`|string|false||| +|`status_code`|integer|false||Status code is the HTTP status code of the request.| +|`user`|[codersdk.User](#codersdkuser)|false||User is omitted if the connection event was from an unauthenticated user.| +|`user_agent`|string|false||| ## codersdk.ConnectionType @@ -1303,14 +1303,14 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in #### Enumerated Values -| Value | -|--------------------| -| `ssh` | -| `vscode` | -| `jetbrains` | -| `reconnecting_pty` | -| `workspace_app` | -| `port_forwarding` | +|Value| +|---| +|`ssh`| +|`vscode`| +|`jetbrains`| +|`reconnecting_pty`| +|`workspace_app`| +|`port_forwarding`| ## codersdk.ConvertLoginRequest @@ -1323,10 +1323,10 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|------------------------------------------|----------|--------------|------------------------------------------| -| `password` | string | true | | | -| `to_type` | [codersdk.LoginType](#codersdklogintype) | true | | To type is the login type to convert to. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`password`|string|true||| +|`to_type`|[codersdk.LoginType](#codersdklogintype)|true||To type is the login type to convert to.| ## codersdk.CreateFirstUserRequest @@ -1351,14 +1351,14 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|------------------------------------------------------------------------|----------|--------------|-------------| -| `email` | string | true | | | -| `name` | string | false | | | -| `password` | string | true | | | -| `trial` | boolean | false | | | -| `trial_info` | [codersdk.CreateFirstUserTrialInfo](#codersdkcreatefirstusertrialinfo) | false | | | -| `username` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`email`|string|true||| +|`name`|string|false||| +|`password`|string|true||| +|`trial`|boolean|false||| +|`trial_info`|[codersdk.CreateFirstUserTrialInfo](#codersdkcreatefirstusertrialinfo)|false||| +|`username`|string|true||| ## codersdk.CreateFirstUserResponse @@ -1371,10 +1371,10 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------|--------|----------|--------------|-------------| -| `organization_id` | string | false | | | -| `user_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`organization_id`|string|false||| +|`user_id`|string|false||| ## codersdk.CreateFirstUserTrialInfo @@ -1392,15 +1392,15 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### 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 | | | +|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||| ## codersdk.CreateGroupRequest @@ -1415,12 +1415,12 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------|---------|----------|--------------|-------------| -| `avatar_url` | string | false | | | -| `display_name` | string | false | | | -| `name` | string | true | | | -| `quota_allowance` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`display_name`|string|false||| +|`name`|string|true||| +|`quota_allowance`|integer|false||| ## codersdk.CreateOrganizationRequest @@ -1435,12 +1435,12 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|------------------------------------------------------------------------| -| `description` | string | false | | | -| `display_name` | string | false | | Display name will default to the same value as `Name` if not provided. | -| `icon` | string | false | | | -| `name` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`description`|string|false||| +|`display_name`|string|false||Display name will default to the same value as `Name` if not provided.| +|`icon`|string|false||| +|`name`|string|true||| ## codersdk.CreateProvisionerKeyResponse @@ -1452,9 +1452,9 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|-------|--------|----------|--------------|-------------| -| `key` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`key`|string|false||| ## codersdk.CreateTemplateRequest @@ -1493,26 +1493,26 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------------------------|--------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `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. | -| `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. | -| `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. | -| `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. | -| `max_port_share_level` | [codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel) | false | | Max port share level allows optionally specifying the maximum port share level for workspaces created from the template. | -| `name` | string | true | | Name is the name of the template. | -| `require_active_version` | boolean | false | | Require active version mandates that workspaces are built with the active template version. | -| `template_use_classic_parameter_flow` | boolean | false | | Template use classic parameter flow allows optionally specifying whether the template should use the classic parameter flow. The default if unset is true, and is why `*bool` is used here. When dynamic parameters becomes the default, this will default to false. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`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.| +|`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.| +|`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.| +|`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.| +|`max_port_share_level`|[codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel)|false||Max port share level allows optionally specifying the maximum port share level for workspaces created from the template.| +|`name`|string|true||Name is the name of the template.| +|`require_active_version`|boolean|false||Require active version mandates that workspaces are built with the active template version.| +|`template_use_classic_parameter_flow`|boolean|false||Template use classic parameter flow allows optionally specifying whether the template should use the classic parameter flow. The default if unset is true, and is why `*bool` is used here. When dynamic parameters becomes the default, this will default to false.| |`template_version_id`|string|true||Template version ID is an in-progress or completed job to use as an initial version of the template. 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.| @@ -1538,11 +1538,11 @@ This is required on creation to enable a user-flow of validating a template work ### Properties -| 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 | | | +|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||| ## codersdk.CreateTemplateVersionRequest @@ -1570,26 +1570,26 @@ This is required on creation to enable a user-flow of validating a template work ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|------------------------------------------------------------------------|----------|--------------|--------------------------------------------------------------| -| `example_id` | string | false | | | -| `file_id` | string | false | | | -| `message` | string | false | | | -| `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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`example_id`|string|false||| +|`file_id`|string|false||| +|`message`|string|false||| +|`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||| #### Enumerated Values -| Property | Value | -|------------------|-------------| -| `provisioner` | `terraform` | -| `provisioner` | `echo` | -| `storage_method` | `file` | +|Property|Value| +|---|---| +|`provisioner`|`terraform`| +|`provisioner`|`echo`| +|`storage_method`|`file`| ## codersdk.CreateTestAuditLogRequest @@ -1610,36 +1610,36 @@ This is required on creation to enable a user-flow of validating a template work ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|------------------------------------------------|----------|--------------|-------------| -| `action` | [codersdk.AuditAction](#codersdkauditaction) | false | | | -| `additional_fields` | array of integer | false | | | -| `build_reason` | [codersdk.BuildReason](#codersdkbuildreason) | false | | | -| `organization_id` | string | false | | | -| `request_id` | string | false | | | -| `resource_id` | string | false | | | -| `resource_type` | [codersdk.ResourceType](#codersdkresourcetype) | false | | | -| `time` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`action`|[codersdk.AuditAction](#codersdkauditaction)|false||| +|`additional_fields`|array of integer|false||| +|`build_reason`|[codersdk.BuildReason](#codersdkbuildreason)|false||| +|`organization_id`|string|false||| +|`request_id`|string|false||| +|`resource_id`|string|false||| +|`resource_type`|[codersdk.ResourceType](#codersdkresourcetype)|false||| +|`time`|string|false||| #### Enumerated Values -| Property | Value | -|-----------------|--------------------| -| `action` | `create` | -| `action` | `write` | -| `action` | `delete` | -| `action` | `start` | -| `action` | `stop` | -| `build_reason` | `autostart` | -| `build_reason` | `autostop` | -| `build_reason` | `initiator` | -| `resource_type` | `template` | -| `resource_type` | `template_version` | -| `resource_type` | `user` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_build` | -| `resource_type` | `git_ssh_key` | -| `resource_type` | `auditable_group` | +|Property|Value| +|---|---| +|`action`|`create`| +|`action`|`write`| +|`action`|`delete`| +|`action`|`start`| +|`action`|`stop`| +|`build_reason`|`autostart`| +|`build_reason`|`autostop`| +|`build_reason`|`initiator`| +|`resource_type`|`template`| +|`resource_type`|`template_version`| +|`resource_type`|`user`| +|`resource_type`|`workspace`| +|`resource_type`|`workspace_build`| +|`resource_type`|`git_ssh_key`| +|`resource_type`|`auditable_group`| ## codersdk.CreateTokenRequest @@ -1653,18 +1653,18 @@ This is required on creation to enable a user-flow of validating a template work ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|----------------------------------------------|----------|--------------|-------------| -| `lifetime` | integer | false | | | -| `scope` | [codersdk.APIKeyScope](#codersdkapikeyscope) | false | | | -| `token_name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`lifetime`|integer|false||| +|`scope`|[codersdk.APIKeyScope](#codersdkapikeyscope)|false||| +|`token_name`|string|false||| #### Enumerated Values -| Property | Value | -|----------|-----------------------| -| `scope` | `all` | -| `scope` | `application_connect` | +|Property|Value| +|---|---| +|`scope`|`all`| +|`scope`|`application_connect`| ## codersdk.CreateUserRequestWithOrgs @@ -1684,15 +1684,15 @@ This is required on creation to enable a user-flow of validating a template work ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|--------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------| -| `email` | string | true | | | -| `login_type` | [codersdk.LoginType](#codersdklogintype) | false | | Login type defaults to LoginTypePassword. | -| `name` | string | false | | | -| `organization_ids` | array of string | false | | Organization ids is a list of organization IDs that the user should be a member of. | -| `password` | string | false | | | -| `user_status` | [codersdk.UserStatus](#codersdkuserstatus) | false | | User status defaults to UserStatusDormant. | -| `username` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`email`|string|true||| +|`login_type`|[codersdk.LoginType](#codersdklogintype)|false||Login type defaults to LoginTypePassword.| +|`name`|string|false||| +|`organization_ids`|array of string|false||Organization ids is a list of organization IDs that the user should be a member of.| +|`password`|string|false||| +|`user_status`|[codersdk.UserStatus](#codersdkuserstatus)|false||User status defaults to UserStatusDormant.| +|`username`|string|true||| ## codersdk.CreateWorkspaceBuildReason @@ -1704,13 +1704,13 @@ This is required on creation to enable a user-flow of validating a template work #### Enumerated Values -| Value | -|------------------------| -| `dashboard` | -| `cli` | -| `ssh_connection` | -| `vscode_connection` | -| `jetbrains_connection` | +|Value| +|---| +|`dashboard`| +|`cli`| +|`ssh_connection`| +|`vscode_connection`| +|`jetbrains_connection`| ## codersdk.CreateWorkspaceBuildRequest @@ -1737,31 +1737,31 @@ This is required on creation to enable a user-flow of validating a template work ### Properties -| 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. | -| `reason` | [codersdk.CreateWorkspaceBuildReason](#codersdkcreateworkspacebuildreason) | false | | Reason sets the reason for the workspace build. | -| `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 | | | -| `template_version_preset_id` | string | false | | Template version preset ID is the ID of the template version preset to use for the build. | -| `transition` | [codersdk.WorkspaceTransition](#codersdkworkspacetransition) | true | | | +|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.| +|`reason`|[codersdk.CreateWorkspaceBuildReason](#codersdkcreateworkspacebuildreason)|false||Reason sets the reason for the workspace build.| +|`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||| +|`template_version_preset_id`|string|false||Template version preset ID is the ID of the template version preset to use for the build.| +|`transition`|[codersdk.WorkspaceTransition](#codersdkworkspacetransition)|true||| #### Enumerated Values -| Property | Value | -|--------------|------------------------| -| `log_level` | `debug` | -| `reason` | `dashboard` | -| `reason` | `cli` | -| `reason` | `ssh_connection` | -| `reason` | `vscode_connection` | -| `reason` | `jetbrains_connection` | -| `transition` | `start` | -| `transition` | `stop` | -| `transition` | `delete` | +|Property|Value| +|---|---| +|`log_level`|`debug`| +|`reason`|`dashboard`| +|`reason`|`cli`| +|`reason`|`ssh_connection`| +|`reason`|`vscode_connection`| +|`reason`|`jetbrains_connection`| +|`transition`|`start`| +|`transition`|`stop`| +|`transition`|`delete`| ## codersdk.CreateWorkspaceProxyRequest @@ -1775,11 +1775,11 @@ This is required on creation to enable a user-flow of validating a template work ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `display_name` | string | false | | | -| `icon` | string | false | | | -| `name` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|false||| +|`icon`|string|false||| +|`name`|string|true||| ## codersdk.CreateWorkspaceRequest @@ -1805,16 +1805,16 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|-------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------| -| `automatic_updates` | [codersdk.AutomaticUpdates](#codersdkautomaticupdates) | false | | | -| `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. | -| `template_version_preset_id` | string | false | | | -| `ttl_ms` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`automatic_updates`|[codersdk.AutomaticUpdates](#codersdkautomaticupdates)|false||| +|`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.| +|`template_version_preset_id`|string|false||| +|`ttl_ms`|integer|false||| ## codersdk.CryptoKey @@ -1830,13 +1830,13 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|--------------------------------------------------------|----------|--------------|-------------| -| `deletes_at` | string | false | | | -| `feature` | [codersdk.CryptoKeyFeature](#codersdkcryptokeyfeature) | false | | | -| `secret` | string | false | | | -| `sequence` | integer | false | | | -| `starts_at` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`deletes_at`|string|false||| +|`feature`|[codersdk.CryptoKeyFeature](#codersdkcryptokeyfeature)|false||| +|`secret`|string|false||| +|`sequence`|integer|false||| +|`starts_at`|string|false||| ## codersdk.CryptoKeyFeature @@ -1848,12 +1848,12 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|--------------------------| -| `workspace_apps_api_key` | -| `workspace_apps_token` | -| `oidc_convert` | -| `tailnet_resume` | +|Value| +|---| +|`workspace_apps_api_key`| +|`workspace_apps_token`| +|`oidc_convert`| +|`tailnet_resume`| ## codersdk.CustomRoleRequest @@ -1887,13 +1887,13 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------------|-----------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------| -| `display_name` | string | false | | | -| `name` | string | false | | | -| `organization_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | Organization permissions are specific to the organization the role belongs to. | -| `site_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | | -| `user_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|false||| +|`name`|string|false||| +|`organization_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||Organization permissions are specific to the organization the role belongs to.| +|`site_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||| +|`user_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||| ## codersdk.DAUEntry @@ -1906,10 +1906,10 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| 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. | +|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.| ## codersdk.DAUsResponse @@ -1927,10 +1927,10 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|-------------------------------------------------|----------|--------------|-------------| -| `entries` | array of [codersdk.DAUEntry](#codersdkdauentry) | false | | | -| `tz_hour_offset` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`entries`|array of [codersdk.DAUEntry](#codersdkdauentry)|false||| +|`tz_hour_offset`|integer|false||| ## codersdk.DERP @@ -1969,10 +1969,10 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|--------------------------------------------------------|----------|--------------|-------------| -| `config` | [codersdk.DERPConfig](#codersdkderpconfig) | false | | | -| `server` | [codersdk.DERPServerConfig](#codersdkderpserverconfig) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`config`|[codersdk.DERPConfig](#codersdkderpconfig)|false||| +|`server`|[codersdk.DERPServerConfig](#codersdkderpserverconfig)|false||| ## codersdk.DERPConfig @@ -1987,12 +1987,12 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------|----------|--------------|-------------| -| `block_direct` | boolean | false | | | -| `force_websockets` | boolean | false | | | -| `path` | string | false | | | -| `url` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`block_direct`|boolean|false||| +|`force_websockets`|boolean|false||| +|`path`|string|false||| +|`url`|string|false||| ## codersdk.DERPRegion @@ -2005,10 +2005,10 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|---------|----------|--------------|-------------| -| `latency_ms` | number | false | | | -| `preferred` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`latency_ms`|number|false||| +|`preferred`|boolean|false||| ## codersdk.DERPServerConfig @@ -2039,14 +2039,14 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|----------------------------|----------|--------------|-------------| -| `enable` | boolean | false | | | -| `region_code` | string | false | | | -| `region_id` | integer | false | | | -| `region_name` | string | false | | | -| `relay_url` | [serpent.URL](#serpenturl) | false | | | -| `stun_addresses` | array of string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`enable`|boolean|false||| +|`region_code`|string|false||| +|`region_id`|integer|false||| +|`region_name`|string|false||| +|`relay_url`|[serpent.URL](#serpenturl)|false||| +|`stun_addresses`|array of string|false||| ## codersdk.DangerousConfig @@ -2060,11 +2060,11 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------------|---------|----------|--------------|-------------| -| `allow_all_cors` | boolean | false | | | -| `allow_path_app_sharing` | boolean | false | | | -| `allow_path_app_site_owner_access` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`allow_all_cors`|boolean|false||| +|`allow_path_app_sharing`|boolean|false||| +|`allow_path_app_site_owner_access`|boolean|false||| ## codersdk.DeleteWebpushSubscription @@ -2076,9 +2076,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|--------|----------|--------------|-------------| -| `endpoint` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`endpoint`|string|false||| ## codersdk.DeleteWorkspaceAgentPortShareRequest @@ -2091,10 +2091,10 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|---------|----------|--------------|-------------| -| `agent_name` | string | false | | | -| `port` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`agent_name`|string|false||| +|`port`|integer|false||| ## codersdk.DeploymentConfig @@ -2540,10 +2540,10 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|--------------------------------------------------------|----------|--------------|-------------| -| `config` | [codersdk.DeploymentValues](#codersdkdeploymentvalues) | false | | | -| `options` | array of [serpent.Option](#serpentoption) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`config`|[codersdk.DeploymentValues](#codersdkdeploymentvalues)|false||| +|`options`|array of [serpent.Option](#serpentoption)|false||| ## codersdk.DeploymentStats @@ -2576,13 +2576,13 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### 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 | | | +|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||| ## codersdk.DeploymentValues @@ -2993,71 +2993,71 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------------------------|------------------------------------------------------------------------------------------------------|----------|--------------|--------------------------------------------------------------------| -| `access_url` | [serpent.URL](#serpenturl) | false | | | -| `additional_csp_policy` | array of string | false | | | -| `address` | [serpent.HostPort](#serpenthostport) | false | | Deprecated: Use HTTPAddress or TLS.Address instead. | -| `agent_fallback_troubleshooting_url` | [serpent.URL](#serpenturl) | false | | | -| `agent_stat_refresh_interval` | integer | false | | | -| `allow_workspace_renames` | boolean | false | | | -| `autobuild_poll_interval` | integer | false | | | -| `browser_only` | boolean | false | | | -| `cache_directory` | string | false | | | -| `cli_upgrade_message` | string | false | | | -| `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 | | | -| `docs_url` | [serpent.URL](#serpenturl) | false | | | -| `enable_terraform_debug_mode` | boolean | false | | | -| `ephemeral_deployment` | boolean | false | | | -| `experiments` | array of string | false | | | -| `external_auth` | [serpent.Struct-array_codersdk_ExternalAuthConfig](#serpentstruct-array_codersdk_externalauthconfig) | false | | | -| `external_token_encryption_keys` | array of string | false | | | -| `healthcheck` | [codersdk.HealthcheckConfig](#codersdkhealthcheckconfig) | false | | | -| `hide_ai_tasks` | boolean | false | | | -| `http_address` | string | false | | Http address is a string because it may be set to zero to disable. | -| `http_cookies` | [codersdk.HTTPCookieConfig](#codersdkhttpcookieconfig) | false | | | -| `job_hang_detector_interval` | integer | false | | | -| `logging` | [codersdk.LoggingConfig](#codersdkloggingconfig) | false | | | -| `metrics_cache_refresh_interval` | integer | false | | | -| `notifications` | [codersdk.NotificationsConfig](#codersdknotificationsconfig) | false | | | -| `oauth2` | [codersdk.OAuth2Config](#codersdkoauth2config) | false | | | -| `oidc` | [codersdk.OIDCConfig](#codersdkoidcconfig) | false | | | -| `pg_auth` | string | 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 | | | -| `session_lifetime` | [codersdk.SessionLifetime](#codersdksessionlifetime) | 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 | | | -| `terms_of_service_url` | string | 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 | | | -| `web_terminal_renderer` | string | false | | | -| `wgtunnel_host` | string | false | | | -| `wildcard_access_url` | string | false | | | -| `workspace_hostname_suffix` | string | false | | | -| `workspace_prebuilds` | [codersdk.PrebuildsConfig](#codersdkprebuildsconfig) | false | | | -| `write_config` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`access_url`|[serpent.URL](#serpenturl)|false||| +|`additional_csp_policy`|array of string|false||| +|`address`|[serpent.HostPort](#serpenthostport)|false||Deprecated: Use HTTPAddress or TLS.Address instead.| +|`agent_fallback_troubleshooting_url`|[serpent.URL](#serpenturl)|false||| +|`agent_stat_refresh_interval`|integer|false||| +|`allow_workspace_renames`|boolean|false||| +|`autobuild_poll_interval`|integer|false||| +|`browser_only`|boolean|false||| +|`cache_directory`|string|false||| +|`cli_upgrade_message`|string|false||| +|`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||| +|`docs_url`|[serpent.URL](#serpenturl)|false||| +|`enable_terraform_debug_mode`|boolean|false||| +|`ephemeral_deployment`|boolean|false||| +|`experiments`|array of string|false||| +|`external_auth`|[serpent.Struct-array_codersdk_ExternalAuthConfig](#serpentstruct-array_codersdk_externalauthconfig)|false||| +|`external_token_encryption_keys`|array of string|false||| +|`healthcheck`|[codersdk.HealthcheckConfig](#codersdkhealthcheckconfig)|false||| +|`hide_ai_tasks`|boolean|false||| +|`http_address`|string|false||Http address is a string because it may be set to zero to disable.| +|`http_cookies`|[codersdk.HTTPCookieConfig](#codersdkhttpcookieconfig)|false||| +|`job_hang_detector_interval`|integer|false||| +|`logging`|[codersdk.LoggingConfig](#codersdkloggingconfig)|false||| +|`metrics_cache_refresh_interval`|integer|false||| +|`notifications`|[codersdk.NotificationsConfig](#codersdknotificationsconfig)|false||| +|`oauth2`|[codersdk.OAuth2Config](#codersdkoauth2config)|false||| +|`oidc`|[codersdk.OIDCConfig](#codersdkoidcconfig)|false||| +|`pg_auth`|string|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||| +|`session_lifetime`|[codersdk.SessionLifetime](#codersdksessionlifetime)|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||| +|`terms_of_service_url`|string|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||| +|`web_terminal_renderer`|string|false||| +|`wgtunnel_host`|string|false||| +|`wildcard_access_url`|string|false||| +|`workspace_hostname_suffix`|string|false||| +|`workspace_prebuilds`|[codersdk.PrebuildsConfig](#codersdkprebuildsconfig)|false||| +|`write_config`|boolean|false||| ## codersdk.DiagnosticExtra @@ -3069,9 +3069,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|--------|--------|----------|--------------|-------------| -| `code` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`code`|string|false||| ## codersdk.DiagnosticSeverityString @@ -3083,10 +3083,10 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|-----------| -| `error` | -| `warning` | +|Value| +|---| +|`error`| +|`warning`| ## codersdk.DisplayApp @@ -3098,13 +3098,13 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|--------------------------| -| `vscode` | -| `vscode_insiders` | -| `web_terminal` | -| `port_forwarding_helper` | -| `ssh_helper` | +|Value| +|---| +|`vscode`| +|`vscode_insiders`| +|`web_terminal`| +|`port_forwarding_helper`| +|`ssh_helper`| ## codersdk.DynamicParametersRequest @@ -3121,12 +3121,12 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------|----------|--------------|--------------------------------------------------------------------------------------------------------------| -| `id` | integer | false | | ID identifies the request. The response contains the same ID so that the client can match it to the request. | -| `inputs` | object | false | | | -| » `[any property]` | string | false | | | -| `owner_id` | string | false | | Owner ID if uuid.Nil, it defaults to `codersdk.Me` | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`id`|integer|false||ID identifies the request. The response contains the same ID so that the client can match it to the request.| +|`inputs`|object|false||| +|» `[any property]`|string|false||| +|`owner_id`|string|false||Owner ID if uuid.Nil, it defaults to `codersdk.Me`| ## codersdk.DynamicParametersResponse @@ -3206,11 +3206,11 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|---------------------------------------------------------------------|----------|--------------|-------------| -| `diagnostics` | array of [codersdk.FriendlyDiagnostic](#codersdkfriendlydiagnostic) | false | | | -| `id` | integer | false | | | -| `parameters` | array of [codersdk.PreviewParameter](#codersdkpreviewparameter) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`diagnostics`|array of [codersdk.FriendlyDiagnostic](#codersdkfriendlydiagnostic)|false||| +|`id`|integer|false||| +|`parameters`|array of [codersdk.PreviewParameter](#codersdkpreviewparameter)|false||| ## codersdk.Entitlement @@ -3222,11 +3222,11 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|----------------| -| `entitled` | -| `grace_period` | -| `not_entitled` | +|Value| +|---| +|`entitled`| +|`grace_period`| +|`not_entitled`| ## codersdk.Entitlements @@ -3273,16 +3273,16 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|--------------------------------------|----------|--------------|-------------| -| `errors` | array of string | false | | | -| `features` | object | false | | | -| » `[any property]` | [codersdk.Feature](#codersdkfeature) | false | | | -| `has_license` | boolean | false | | | -| `refreshed_at` | string | false | | | -| `require_telemetry` | boolean | false | | | -| `trial` | boolean | false | | | -| `warnings` | array of string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`errors`|array of string|false||| +|`features`|object|false||| +|» `[any property]`|[codersdk.Feature](#codersdkfeature)|false||| +|`has_license`|boolean|false||| +|`refreshed_at`|string|false||| +|`require_telemetry`|boolean|false||| +|`trial`|boolean|false||| +|`warnings`|array of string|false||| ## codersdk.Experiment @@ -3294,15 +3294,15 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|------------------------| -| `example` | -| `auto-fill-parameters` | -| `notifications` | -| `workspace-usage` | -| `web-push` | -| `oauth2` | -| `mcp-server-http` | +|Value| +|---| +|`example`| +|`auto-fill-parameters`| +|`notifications`| +|`workspace-usage`| +|`web-push`| +|`oauth2`| +|`mcp-server-http`| ## codersdk.ExternalAuth @@ -3338,15 +3338,15 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### 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 | | | -| `display_name` | string | false | | | -| `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. | +|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||| +|`display_name`|string|false||| +|`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 @@ -3366,11 +3366,11 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|--------------------------------------------------------|----------|--------------|-------------| -| `account` | [codersdk.ExternalAuthUser](#codersdkexternalauthuser) | false | | | -| `configure_url` | string | false | | | -| `id` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`account`|[codersdk.ExternalAuthUser](#codersdkexternalauthuser)|false||| +|`configure_url`|string|false||| +|`id`|integer|false||| ## codersdk.ExternalAuthConfig @@ -3398,18 +3398,18 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o ### 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. | -| `id` | string | false | | ID is a unique identifier for the auth config. It defaults to `type` when not provided. | -| `no_refresh` | boolean | false | | | +|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.| +|`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||| @@ -3431,13 +3431,13 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith ### 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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`device_code`|string|false||| +|`expires_in`|integer|false||| +|`interval`|integer|false||| +|`user_code`|string|false||| +|`verification_uri`|string|false||| ## codersdk.ExternalAuthLink @@ -3455,15 +3455,15 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|---------|----------|--------------|-------------| -| `authenticated` | boolean | false | | | -| `created_at` | string | false | | | -| `expires` | string | false | | | -| `has_refresh_token` | boolean | false | | | -| `provider_id` | string | false | | | -| `updated_at` | string | false | | | -| `validate_error` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`authenticated`|boolean|false||| +|`created_at`|string|false||| +|`expires`|string|false||| +|`has_refresh_token`|boolean|false||| +|`provider_id`|string|false||| +|`updated_at`|string|false||| +|`validate_error`|string|false||| ## codersdk.ExternalAuthUser @@ -3479,13 +3479,13 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|---------|----------|--------------|-------------| -| `avatar_url` | string | false | | | -| `id` | integer | false | | | -| `login` | string | false | | | -| `name` | string | false | | | -| `profile_url` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`id`|integer|false||| +|`login`|string|false||| +|`name`|string|false||| +|`profile_url`|string|false||| ## codersdk.Feature @@ -3506,13 +3506,13 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|----------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `actual` | integer | false | | | -| `enabled` | boolean | false | | | -| `entitlement` | [codersdk.Entitlement](#codersdkentitlement) | false | | | -| `limit` | integer | false | | | -| `soft_limit` | integer | false | | Soft limit is the soft limit of the feature, and is only used for showing included limits in the dashboard. No license validation or warnings are generated from this value. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`actual`|integer|false||| +|`enabled`|boolean|false||| +|`entitlement`|[codersdk.Entitlement](#codersdkentitlement)|false||| +|`limit`|integer|false||| +|`soft_limit`|integer|false||Soft limit is the soft limit of the feature, and is only used for showing included limits in the dashboard. No license validation or warnings are generated from this value.| |`usage_period`|[codersdk.UsagePeriod](#codersdkusageperiod)|false||Usage period denotes that the usage is a counter that accumulates over this period (and most likely resets with the issuance of the next license). These dates are determined from the license that this entitlement comes from, see enterprise/coderd/license/license.go. Only certain features set these fields: - FeatureManagedAgentLimit| @@ -3532,12 +3532,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|------------------------------------------------------------------------|----------|--------------|-------------| -| `detail` | string | false | | | -| `extra` | [codersdk.DiagnosticExtra](#codersdkdiagnosticextra) | false | | | -| `severity` | [codersdk.DiagnosticSeverityString](#codersdkdiagnosticseveritystring) | false | | | -| `summary` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`detail`|string|false||| +|`extra`|[codersdk.DiagnosticExtra](#codersdkdiagnosticextra)|false||| +|`severity`|[codersdk.DiagnosticSeverityString](#codersdkdiagnosticseveritystring)|false||| +|`summary`|string|false||| ## codersdk.GenerateAPIKeyResponse @@ -3549,9 +3549,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------|--------|----------|--------------|-------------| -| `key` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`key`|string|false||| ## codersdk.GetInboxNotificationResponse @@ -3582,10 +3582,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|----------------------------------------------------------|----------|--------------|-------------| -| `notification` | [codersdk.InboxNotification](#codersdkinboxnotification) | false | | | -| `unread_count` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`notification`|[codersdk.InboxNotification](#codersdkinboxnotification)|false||| +|`unread_count`|integer|false||| ## codersdk.GetUserStatusCountsResponse @@ -3610,10 +3610,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------------------------------------------------------------------------|----------|--------------|-------------| -| `status_counts` | object | false | | | -| » `[any property]` | array of [codersdk.UserStatusChangeCount](#codersdkuserstatuschangecount) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`status_counts`|object|false||| +|» `[any property]`|array of [codersdk.UserStatusChangeCount](#codersdkuserstatuschangecount)|false||| ## codersdk.GetUsersResponse @@ -3650,10 +3650,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|-----------------------------------------|----------|--------------|-------------| -| `count` | integer | false | | | -| `users` | array of [codersdk.User](#codersdkuser) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`count`|integer|false||| +|`users`|array of [codersdk.User](#codersdkuser)|false||| ## codersdk.GitSSHKey @@ -3668,12 +3668,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|--------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `created_at` | string | false | | | -| `public_key` | string | false | | Public key is the SSH public key in OpenSSH format. Example: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID3OmYJvT7q1cF1azbybYy0OZ9yrXfA+M6Lr4vzX5zlp\n" Note: The key includes a trailing newline (\n). | -| `updated_at` | string | false | | | -| `user_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|false||| +|`public_key`|string|false||Public key is the SSH public key in OpenSSH format. Example: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID3OmYJvT7q1cF1azbybYy0OZ9yrXfA+M6Lr4vzX5zlp\n" Note: The key includes a trailing newline (\n).| +|`updated_at`|string|false||| +|`user_id`|string|false||| ## codersdk.GithubAuthMethod @@ -3686,10 +3686,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------------|---------|----------|--------------|-------------| -| `default_provider_configured` | boolean | false | | | -| `enabled` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`default_provider_configured`|boolean|false||| +|`enabled`|boolean|false||| ## codersdk.Group @@ -3725,19 +3725,19 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------------------|-------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `avatar_url` | string | false | | | -| `display_name` | string | false | | | -| `id` | string | false | | | -| `members` | array of [codersdk.ReducedUser](#codersdkreduceduser) | false | | | -| `name` | string | false | | | -| `organization_display_name` | string | false | | | -| `organization_id` | string | false | | | -| `organization_name` | string | false | | | -| `quota_allowance` | integer | false | | | -| `source` | [codersdk.GroupSource](#codersdkgroupsource) | false | | | -| `total_member_count` | integer | false | | How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`display_name`|string|false||| +|`id`|string|false||| +|`members`|array of [codersdk.ReducedUser](#codersdkreduceduser)|false||| +|`name`|string|false||| +|`organization_display_name`|string|false||| +|`organization_id`|string|false||| +|`organization_name`|string|false||| +|`quota_allowance`|integer|false||| +|`source`|[codersdk.GroupSource](#codersdkgroupsource)|false||| +|`total_member_count`|integer|false||How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`.| ## codersdk.GroupSource @@ -3749,10 +3749,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|--------| -| `user` | -| `oidc` | +|Value| +|---| +|`user`| +|`oidc`| ## codersdk.GroupSyncSettings @@ -3778,15 +3778,15 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|--------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `auto_create_missing_groups` | boolean | false | | Auto create missing groups controls whether groups returned by the OIDC provider are automatically created in Coder if they are missing. | -| `field` | string | false | | Field is the name of the claim field that specifies what groups a user should be in. If empty, no groups will be synced. | -| `legacy_group_name_mapping` | object | false | | Legacy group name mapping is deprecated. It remaps an IDP group name to a Coder group name. Since configuration is now done at runtime, group IDs are used to account for group renames. For legacy configurations, this config option has to remain. Deprecated: Use Mapping instead. | -| » `[any property]` | string | false | | | -| `mapping` | object | false | | Mapping is a map from OIDC groups to Coder group IDs | -| » `[any property]` | array of string | false | | | -| `regex_filter` | [regexp.Regexp](#regexpregexp) | false | | Regex filter is a regular expression that filters the groups returned by the OIDC provider. Any group not matched by this regex will be ignored. If the group filter is nil, then no group filtering will occur. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`auto_create_missing_groups`|boolean|false||Auto create missing groups controls whether groups returned by the OIDC provider are automatically created in Coder if they are missing.| +|`field`|string|false||Field is the name of the claim field that specifies what groups a user should be in. If empty, no groups will be synced.| +|`legacy_group_name_mapping`|object|false||Legacy group name mapping is deprecated. It remaps an IDP group name to a Coder group name. Since configuration is now done at runtime, group IDs are used to account for group renames. For legacy configurations, this config option has to remain. Deprecated: Use Mapping instead.| +|» `[any property]`|string|false||| +|`mapping`|object|false||Mapping is a map from OIDC groups to Coder group IDs| +|» `[any property]`|array of string|false||| +|`regex_filter`|[regexp.Regexp](#regexpregexp)|false||Regex filter is a regular expression that filters the groups returned by the OIDC provider. Any group not matched by this regex will be ignored. If the group filter is nil, then no group filtering will occur.| ## codersdk.HTTPCookieConfig @@ -3799,10 +3799,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|---------|----------|--------------|-------------| -| `same_site` | string | false | | | -| `secure_auth_cookie` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`same_site`|string|false||| +|`secure_auth_cookie`|boolean|false||| ## codersdk.Healthcheck @@ -3816,11 +3816,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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. | +|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.| ## codersdk.HealthcheckConfig @@ -3833,10 +3833,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|---------|----------|--------------|-------------| -| `refresh` | integer | false | | | -| `threshold_database` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`refresh`|integer|false||| +|`threshold_database`|integer|false||| ## codersdk.InboxNotification @@ -3864,18 +3864,18 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|-------------------------------------------------------------------------------|----------|--------------|-------------| -| `actions` | array of [codersdk.InboxNotificationAction](#codersdkinboxnotificationaction) | false | | | -| `content` | string | false | | | -| `created_at` | string | false | | | -| `icon` | string | false | | | -| `id` | string | false | | | -| `read_at` | string | false | | | -| `targets` | array of string | false | | | -| `template_id` | string | false | | | -| `title` | string | false | | | -| `user_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`actions`|array of [codersdk.InboxNotificationAction](#codersdkinboxnotificationaction)|false||| +|`content`|string|false||| +|`created_at`|string|false||| +|`icon`|string|false||| +|`id`|string|false||| +|`read_at`|string|false||| +|`targets`|array of string|false||| +|`template_id`|string|false||| +|`title`|string|false||| +|`user_id`|string|false||| ## codersdk.InboxNotificationAction @@ -3888,10 +3888,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|--------|----------|--------------|-------------| -| `label` | string | false | | | -| `url` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`label`|string|false||| +|`url`|string|false||| ## codersdk.InsightsReportInterval @@ -3903,10 +3903,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|--------| -| `day` | -| `week` | +|Value| +|---| +|`day`| +|`week`| ## codersdk.IssueReconnectingPTYSignedTokenRequest @@ -3919,10 +3919,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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. | +|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 @@ -3934,9 +3934,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `signed_token` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`signed_token`|string|false||| ## codersdk.JobErrorCode @@ -3948,9 +3948,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-------------------------------| -| `REQUIRED_TEMPLATE_VARIABLES` | +|Value| +|---| +|`REQUIRED_TEMPLATE_VARIABLES`| ## codersdk.License @@ -3965,12 +3965,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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 | | | +|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||| ## codersdk.LinkConfig @@ -3984,19 +3984,19 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|--------|----------|--------------|-------------| -| `icon` | string | false | | | -| `name` | string | false | | | -| `target` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`icon`|string|false||| +|`name`|string|false||| +|`target`|string|false||| #### Enumerated Values -| Property | Value | -|----------|--------| -| `icon` | `bug` | -| `icon` | `chat` | -| `icon` | `docs` | +|Property|Value| +|---|---| +|`icon`|`bug`| +|`icon`|`chat`| +|`icon`|`docs`| ## codersdk.ListInboxNotificationsResponse @@ -4029,10 +4029,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|-------------------------------------------------------------------|----------|--------------|-------------| -| `notifications` | array of [codersdk.InboxNotification](#codersdkinboxnotification) | false | | | -| `unread_count` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`notifications`|array of [codersdk.InboxNotification](#codersdkinboxnotification)|false||| +|`unread_count`|integer|false||| ## codersdk.LogLevel @@ -4044,13 +4044,13 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|---------| -| `trace` | -| `debug` | -| `info` | -| `warn` | -| `error` | +|Value| +|---| +|`trace`| +|`debug`| +|`info`| +|`warn`| +|`error`| ## codersdk.LogSource @@ -4062,10 +4062,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------------| -| `provisioner_daemon` | -| `provisioner` | +|Value| +|---| +|`provisioner_daemon`| +|`provisioner`| ## codersdk.LoggingConfig @@ -4082,12 +4082,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|-----------------|----------|--------------|-------------| -| `human` | string | false | | | -| `json` | string | false | | | -| `log_filter` | array of string | false | | | -| `stackdriver` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`human`|string|false||| +|`json`|string|false||| +|`log_filter`|array of string|false||| +|`stackdriver`|string|false||| ## codersdk.LoginType @@ -4099,14 +4099,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|------------| -| `` | -| `password` | -| `github` | -| `oidc` | -| `token` | -| `none` | +|Value| +|---| +|``| +|`password`| +|`github`| +|`oidc`| +|`token`| +|`none`| ## codersdk.LoginWithPasswordRequest @@ -4119,10 +4119,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|--------|----------|--------------|-------------| -| `email` | string | true | | | -| `password` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`email`|string|true||| +|`password`|string|true||| ## codersdk.LoginWithPasswordResponse @@ -4134,9 +4134,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|--------|----------|--------------|-------------| -| `session_token` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`session_token`|string|true||| ## codersdk.MatchedProvisioners @@ -4150,11 +4150,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|---------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `available` | integer | false | | Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped. | -| `count` | integer | false | | Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags. | -| `most_recently_seen` | string | false | | Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`available`|integer|false||Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped.| +|`count`|integer|false||Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags.| +|`most_recently_seen`|string|false||Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null.| ## codersdk.MinimalOrganization @@ -4169,12 +4169,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `display_name` | string | false | | | -| `icon` | string | false | | | -| `id` | string | true | | | -| `name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|false||| +|`icon`|string|false||| +|`id`|string|true||| +|`name`|string|false||| ## codersdk.MinimalUser @@ -4188,11 +4188,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|--------|----------|--------------|-------------| -| `avatar_url` | string | false | | | -| `id` | string | true | | | -| `username` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`id`|string|true||| +|`username`|string|true||| ## codersdk.NotificationMethodsResponse @@ -4207,10 +4207,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|-----------------|----------|--------------|-------------| -| `available` | array of string | false | | | -| `default` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`available`|array of string|false||| +|`default`|string|false||| ## codersdk.NotificationPreference @@ -4224,11 +4224,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|---------|----------|--------------|-------------| -| `disabled` | boolean | false | | | -| `id` | string | false | | | -| `updated_at` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`disabled`|boolean|false||| +|`id`|string|false||| +|`updated_at`|string|false||| ## codersdk.NotificationTemplate @@ -4248,17 +4248,17 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|---------|----------|--------------|-------------| -| `actions` | string | false | | | -| `body_template` | string | false | | | -| `enabled_by_default` | boolean | false | | | -| `group` | string | false | | | -| `id` | string | false | | | -| `kind` | string | false | | | -| `method` | string | false | | | -| `name` | string | false | | | -| `title_template` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`actions`|string|false||| +|`body_template`|string|false||| +|`enabled_by_default`|boolean|false||| +|`group`|string|false||| +|`id`|string|false||| +|`kind`|string|false||| +|`method`|string|false||| +|`name`|string|false||| +|`title_template`|string|false||| ## codersdk.NotificationsConfig @@ -4316,20 +4316,20 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|----------------------------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `dispatch_timeout` | integer | false | | How long to wait while a notification is being sent before giving up. | -| `email` | [codersdk.NotificationsEmailConfig](#codersdknotificationsemailconfig) | false | | Email settings. | -| `fetch_interval` | integer | false | | How often to query the database for queued notifications. | -| `inbox` | [codersdk.NotificationsInboxConfig](#codersdknotificationsinboxconfig) | false | | Inbox settings. | -| `lease_count` | integer | false | | How many notifications a notifier should lease per fetch interval. | -| `lease_period` | integer | false | | How long a notifier should lease a message. This is effectively how long a notification is 'owned' by a notifier, and once this period expires it will be available for lease by another notifier. Leasing is important in order for multiple running notifiers to not pick the same messages to deliver concurrently. This lease period will only expire if a notifier shuts down ungracefully; a dispatch of the notification releases the lease. | -| `max_send_attempts` | integer | false | | The upper limit of attempts to send a notification. | -| `method` | string | false | | Which delivery method to use (available options: 'smtp', 'webhook'). | -| `retry_interval` | integer | false | | The minimum time between retries. | -| `sync_buffer_size` | integer | false | | The notifications system buffers message updates in memory to ease pressure on the database. This option controls how many updates are kept in memory. The lower this value the lower the change of state inconsistency in a non-graceful shutdown - but it also increases load on the database. It is recommended to keep this option at its default value. | -| `sync_interval` | integer | false | | The notifications system buffers message updates in memory to ease pressure on the database. This option controls how often it synchronizes its state with the database. The shorter this value the lower the change of state inconsistency in a non-graceful shutdown - but it also increases load on the database. It is recommended to keep this option at its default value. | -| `webhook` | [codersdk.NotificationsWebhookConfig](#codersdknotificationswebhookconfig) | false | | Webhook settings. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`dispatch_timeout`|integer|false||How long to wait while a notification is being sent before giving up.| +|`email`|[codersdk.NotificationsEmailConfig](#codersdknotificationsemailconfig)|false||Email settings.| +|`fetch_interval`|integer|false||How often to query the database for queued notifications.| +|`inbox`|[codersdk.NotificationsInboxConfig](#codersdknotificationsinboxconfig)|false||Inbox settings.| +|`lease_count`|integer|false||How many notifications a notifier should lease per fetch interval.| +|`lease_period`|integer|false||How long a notifier should lease a message. This is effectively how long a notification is 'owned' by a notifier, and once this period expires it will be available for lease by another notifier. Leasing is important in order for multiple running notifiers to not pick the same messages to deliver concurrently. This lease period will only expire if a notifier shuts down ungracefully; a dispatch of the notification releases the lease.| +|`max_send_attempts`|integer|false||The upper limit of attempts to send a notification.| +|`method`|string|false||Which delivery method to use (available options: 'smtp', 'webhook').| +|`retry_interval`|integer|false||The minimum time between retries.| +|`sync_buffer_size`|integer|false||The notifications system buffers message updates in memory to ease pressure on the database. This option controls how many updates are kept in memory. The lower this value the lower the change of state inconsistency in a non-graceful shutdown - but it also increases load on the database. It is recommended to keep this option at its default value.| +|`sync_interval`|integer|false||The notifications system buffers message updates in memory to ease pressure on the database. This option controls how often it synchronizes its state with the database. The shorter this value the lower the change of state inconsistency in a non-graceful shutdown - but it also increases load on the database. It is recommended to keep this option at its default value.| +|`webhook`|[codersdk.NotificationsWebhookConfig](#codersdknotificationswebhookconfig)|false||Webhook settings.| ## codersdk.NotificationsEmailAuthConfig @@ -4344,12 +4344,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|--------|----------|--------------|------------------------------------------------------------| -| `identity` | string | false | | Identity for PLAIN auth. | -| `password` | string | false | | Password for LOGIN/PLAIN auth. | -| `password_file` | string | false | | File from which to load the password for LOGIN/PLAIN auth. | -| `username` | string | false | | Username for LOGIN/PLAIN auth. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`identity`|string|false||Identity for PLAIN auth.| +|`password`|string|false||Password for LOGIN/PLAIN auth.| +|`password_file`|string|false||File from which to load the password for LOGIN/PLAIN auth.| +|`username`|string|false||Username for LOGIN/PLAIN auth.| ## codersdk.NotificationsEmailConfig @@ -4378,14 +4378,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|--------------------------------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------| -| `auth` | [codersdk.NotificationsEmailAuthConfig](#codersdknotificationsemailauthconfig) | false | | Authentication details. | -| `force_tls` | boolean | false | | Force tls causes a TLS connection to be attempted. | -| `from` | string | false | | The sender's address. | -| `hello` | string | false | | The hostname identifying the SMTP server. | -| `smarthost` | string | false | | The intermediary SMTP host through which emails are sent (host:port). | -| `tls` | [codersdk.NotificationsEmailTLSConfig](#codersdknotificationsemailtlsconfig) | false | | Tls details. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`auth`|[codersdk.NotificationsEmailAuthConfig](#codersdknotificationsemailauthconfig)|false||Authentication details.| +|`force_tls`|boolean|false||Force tls causes a TLS connection to be attempted.| +|`from`|string|false||The sender's address.| +|`hello`|string|false||The hostname identifying the SMTP server.| +|`smarthost`|string|false||The intermediary SMTP host through which emails are sent (host:port).| +|`tls`|[codersdk.NotificationsEmailTLSConfig](#codersdknotificationsemailtlsconfig)|false||Tls details.| ## codersdk.NotificationsEmailTLSConfig @@ -4402,14 +4402,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|---------|----------|--------------|--------------------------------------------------------------| -| `ca_file` | string | false | | Ca file specifies the location of the CA certificate to use. | -| `cert_file` | string | false | | Cert file specifies the location of the certificate to use. | -| `insecure_skip_verify` | boolean | false | | Insecure skip verify skips target certificate validation. | -| `key_file` | string | false | | Key file specifies the location of the key to use. | -| `server_name` | string | false | | Server name to verify the hostname for the targets. | -| `start_tls` | boolean | false | | Start tls attempts to upgrade plain connections to TLS. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`ca_file`|string|false||Ca file specifies the location of the CA certificate to use.| +|`cert_file`|string|false||Cert file specifies the location of the certificate to use.| +|`insecure_skip_verify`|boolean|false||Insecure skip verify skips target certificate validation.| +|`key_file`|string|false||Key file specifies the location of the key to use.| +|`server_name`|string|false||Server name to verify the hostname for the targets.| +|`start_tls`|boolean|false||Start tls attempts to upgrade plain connections to TLS.| ## codersdk.NotificationsInboxConfig @@ -4421,9 +4421,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|---------|----------|--------------|-------------| -| `enabled` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`enabled`|boolean|false||| ## codersdk.NotificationsSettings @@ -4435,9 +4435,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------|---------|----------|--------------|-------------| -| `notifier_paused` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`notifier_paused`|boolean|false||| ## codersdk.NotificationsWebhookConfig @@ -4461,9 +4461,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|----------------------------|----------|--------------|----------------------------------------------------------------------| -| `endpoint` | [serpent.URL](#serpenturl) | false | | The URL to which the payload will be sent with an HTTP POST request. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`endpoint`|[serpent.URL](#serpenturl)|false||The URL to which the payload will be sent with an HTTP POST request.| ## codersdk.NullHCLString @@ -4476,10 +4476,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|---------|----------|--------------|-------------| -| `valid` | boolean | false | | | -| `value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`valid`|boolean|false||| +|`value`|string|false||| ## codersdk.OAuth2AppEndpoints @@ -4493,11 +4493,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|--------|----------|--------------|-----------------------------------| -| `authorization` | string | false | | | -| `device_authorization` | string | false | | Device authorization is optional. | -| `token` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`authorization`|string|false||| +|`device_authorization`|string|false||Device authorization is optional.| +|`token`|string|false||| ## codersdk.OAuth2AuthorizationServerMetadata @@ -4527,17 +4527,17 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------------------------------|-----------------|----------|--------------|-------------| -| `authorization_endpoint` | string | false | | | -| `code_challenge_methods_supported` | array of string | false | | | -| `grant_types_supported` | array of string | false | | | -| `issuer` | string | false | | | -| `registration_endpoint` | string | false | | | -| `response_types_supported` | array of string | false | | | -| `scopes_supported` | array of string | false | | | -| `token_endpoint` | string | false | | | -| `token_endpoint_auth_methods_supported` | array of string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`authorization_endpoint`|string|false||| +|`code_challenge_methods_supported`|array of string|false||| +|`grant_types_supported`|array of string|false||| +|`issuer`|string|false||| +|`registration_endpoint`|string|false||| +|`response_types_supported`|array of string|false||| +|`scopes_supported`|array of string|false||| +|`token_endpoint`|string|false||| +|`token_endpoint_auth_methods_supported`|array of string|false||| ## codersdk.OAuth2ClientConfiguration @@ -4576,28 +4576,28 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|-----------------|----------|--------------|-------------| -| `client_id` | string | false | | | -| `client_id_issued_at` | integer | false | | | -| `client_name` | string | false | | | -| `client_secret_expires_at` | integer | false | | | -| `client_uri` | string | false | | | -| `contacts` | array of string | false | | | -| `grant_types` | array of string | false | | | -| `jwks` | object | false | | | -| `jwks_uri` | string | false | | | -| `logo_uri` | string | false | | | -| `policy_uri` | string | false | | | -| `redirect_uris` | array of string | false | | | -| `registration_access_token` | string | false | | | -| `registration_client_uri` | string | false | | | -| `response_types` | array of string | false | | | -| `scope` | string | false | | | -| `software_id` | string | false | | | -| `software_version` | string | false | | | -| `token_endpoint_auth_method` | string | false | | | -| `tos_uri` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`client_id`|string|false||| +|`client_id_issued_at`|integer|false||| +|`client_name`|string|false||| +|`client_secret_expires_at`|integer|false||| +|`client_uri`|string|false||| +|`contacts`|array of string|false||| +|`grant_types`|array of string|false||| +|`jwks`|object|false||| +|`jwks_uri`|string|false||| +|`logo_uri`|string|false||| +|`policy_uri`|string|false||| +|`redirect_uris`|array of string|false||| +|`registration_access_token`|string|false||| +|`registration_client_uri`|string|false||| +|`response_types`|array of string|false||| +|`scope`|string|false||| +|`software_id`|string|false||| +|`software_version`|string|false||| +|`token_endpoint_auth_method`|string|false||| +|`tos_uri`|string|false||| ## codersdk.OAuth2ClientRegistrationRequest @@ -4632,24 +4632,24 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|-----------------|----------|--------------|-------------| -| `client_name` | string | false | | | -| `client_uri` | string | false | | | -| `contacts` | array of string | false | | | -| `grant_types` | array of string | false | | | -| `jwks` | object | false | | | -| `jwks_uri` | string | false | | | -| `logo_uri` | string | false | | | -| `policy_uri` | string | false | | | -| `redirect_uris` | array of string | false | | | -| `response_types` | array of string | false | | | -| `scope` | string | false | | | -| `software_id` | string | false | | | -| `software_statement` | string | false | | | -| `software_version` | string | false | | | -| `token_endpoint_auth_method` | string | false | | | -| `tos_uri` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`client_name`|string|false||| +|`client_uri`|string|false||| +|`contacts`|array of string|false||| +|`grant_types`|array of string|false||| +|`jwks`|object|false||| +|`jwks_uri`|string|false||| +|`logo_uri`|string|false||| +|`policy_uri`|string|false||| +|`redirect_uris`|array of string|false||| +|`response_types`|array of string|false||| +|`scope`|string|false||| +|`software_id`|string|false||| +|`software_statement`|string|false||| +|`software_version`|string|false||| +|`token_endpoint_auth_method`|string|false||| +|`tos_uri`|string|false||| ## codersdk.OAuth2ClientRegistrationResponse @@ -4689,29 +4689,29 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|-----------------|----------|--------------|-------------| -| `client_id` | string | false | | | -| `client_id_issued_at` | integer | false | | | -| `client_name` | string | false | | | -| `client_secret` | string | false | | | -| `client_secret_expires_at` | integer | false | | | -| `client_uri` | string | false | | | -| `contacts` | array of string | false | | | -| `grant_types` | array of string | false | | | -| `jwks` | object | false | | | -| `jwks_uri` | string | false | | | -| `logo_uri` | string | false | | | -| `policy_uri` | string | false | | | -| `redirect_uris` | array of string | false | | | -| `registration_access_token` | string | false | | | -| `registration_client_uri` | string | false | | | -| `response_types` | array of string | false | | | -| `scope` | string | false | | | -| `software_id` | string | false | | | -| `software_version` | string | false | | | -| `token_endpoint_auth_method` | string | false | | | -| `tos_uri` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`client_id`|string|false||| +|`client_id_issued_at`|integer|false||| +|`client_name`|string|false||| +|`client_secret`|string|false||| +|`client_secret_expires_at`|integer|false||| +|`client_uri`|string|false||| +|`contacts`|array of string|false||| +|`grant_types`|array of string|false||| +|`jwks`|object|false||| +|`jwks_uri`|string|false||| +|`logo_uri`|string|false||| +|`policy_uri`|string|false||| +|`redirect_uris`|array of string|false||| +|`registration_access_token`|string|false||| +|`registration_client_uri`|string|false||| +|`response_types`|array of string|false||| +|`scope`|string|false||| +|`software_id`|string|false||| +|`software_version`|string|false||| +|`token_endpoint_auth_method`|string|false||| +|`tos_uri`|string|false||| ## codersdk.OAuth2Config @@ -4737,9 +4737,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|------------------------------------------------------------|----------|--------------|-------------| -| `github` | [codersdk.OAuth2GithubConfig](#codersdkoauth2githubconfig) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`github`|[codersdk.OAuth2GithubConfig](#codersdkoauth2githubconfig)|false||| ## codersdk.OAuth2GithubConfig @@ -4763,17 +4763,17 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| 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 | | | -| `default_provider_enable` | boolean | false | | | -| `device_flow` | boolean | false | | | -| `enterprise_base_url` | string | false | | | +|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||| +|`default_provider_enable`|boolean|false||| +|`device_flow`|boolean|false||| +|`enterprise_base_url`|string|false||| ## codersdk.OAuth2ProtectedResourceMetadata @@ -4794,12 +4794,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------------|-----------------|----------|--------------|-------------| -| `authorization_servers` | array of string | false | | | -| `bearer_methods_supported` | array of string | false | | | -| `resource` | string | false | | | -| `scopes_supported` | array of string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`authorization_servers`|array of string|false||| +|`bearer_methods_supported`|array of string|false||| +|`resource`|string|false||| +|`scopes_supported`|array of string|false||| ## codersdk.OAuth2ProviderApp @@ -4819,13 +4819,13 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| 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 | | | +|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||| ## codersdk.OAuth2ProviderAppSecret @@ -4839,11 +4839,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------------|--------|----------|--------------|-------------| -| `client_secret_truncated` | string | false | | | -| `id` | string | false | | | -| `last_used_at` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`client_secret_truncated`|string|false||| +|`id`|string|false||| +|`last_used_at`|string|false||| ## codersdk.OAuth2ProviderAppSecretFull @@ -4856,10 +4856,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|--------|----------|--------------|-------------| -| `client_secret_full` | string | false | | | -| `id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`client_secret_full`|string|false||| +|`id`|string|false||| ## codersdk.OAuthConversionResponse @@ -4874,12 +4874,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|------------------------------------------|----------|--------------|-------------| -| `expires_at` | string | false | | | -| `state_string` | string | false | | | -| `to_type` | [codersdk.LoginType](#codersdklogintype) | false | | | -| `user_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`expires_at`|string|false||| +|`state_string`|string|false||| +|`to_type`|[codersdk.LoginType](#codersdklogintype)|false||| +|`user_id`|string|false||| ## codersdk.OIDCAuthMethod @@ -4893,11 +4893,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|---------|----------|--------------|-------------| -| `enabled` | boolean | false | | | -| `iconUrl` | string | false | | | -| `signInText` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`enabled`|boolean|false||| +|`iconUrl`|string|false||| +|`signInText`|string|false||| ## codersdk.OIDCConfig @@ -4958,38 +4958,38 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| 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 | | | -| `group_allow_list` | array of string | false | | | -| `group_auto_create` | boolean | false | | | -| `group_mapping` | object | false | | | -| `group_regex_filter` | [serpent.Regexp](#serpentregexp) | false | | | -| `groups_field` | string | false | | | -| `icon_url` | [serpent.URL](#serpenturl) | false | | | -| `ignore_email_verified` | boolean | false | | | -| `ignore_user_info` | boolean | false | | Ignore user info & UserInfoFromAccessToken are mutually exclusive. Only 1 can be set to true. Ideally this would be an enum with 3 states, ['none', 'userinfo', 'access_token']. However, for backward compatibility, `ignore_user_info` must remain. And `access_token` is a niche, non-spec compliant edge case. So it's use is rare, and should not be advised. | -| `issuer_url` | string | false | | | -| `name_field` | string | false | | | -| `organization_assign_default` | boolean | false | | | -| `organization_field` | string | false | | | -| `organization_mapping` | object | false | | | -| `scopes` | array of string | false | | | -| `sign_in_text` | string | false | | | -| `signups_disabled_text` | string | false | | | -| `skip_issuer_checks` | boolean | false | | | -| `source_user_info_from_access_token` | boolean | false | | Source user info from access token as mentioned above is an edge case. This allows sourcing the user_info from the access token itself instead of a user_info endpoint. This assumes the access token is a valid JWT with a set of claims to be merged with the id_token. | -| `user_role_field` | string | false | | | -| `user_role_mapping` | object | false | | | -| `user_roles_default` | array of string | false | | | -| `username_field` | string | false | | | +|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||| +|`group_allow_list`|array of string|false||| +|`group_auto_create`|boolean|false||| +|`group_mapping`|object|false||| +|`group_regex_filter`|[serpent.Regexp](#serpentregexp)|false||| +|`groups_field`|string|false||| +|`icon_url`|[serpent.URL](#serpenturl)|false||| +|`ignore_email_verified`|boolean|false||| +|`ignore_user_info`|boolean|false||Ignore user info & UserInfoFromAccessToken are mutually exclusive. Only 1 can be set to true. Ideally this would be an enum with 3 states, ['none', 'userinfo', 'access_token']. However, for backward compatibility, `ignore_user_info` must remain. And `access_token` is a niche, non-spec compliant edge case. So it's use is rare, and should not be advised.| +|`issuer_url`|string|false||| +|`name_field`|string|false||| +|`organization_assign_default`|boolean|false||| +|`organization_field`|string|false||| +|`organization_mapping`|object|false||| +|`scopes`|array of string|false||| +|`sign_in_text`|string|false||| +|`signups_disabled_text`|string|false||| +|`skip_issuer_checks`|boolean|false||| +|`source_user_info_from_access_token`|boolean|false||Source user info from access token as mentioned above is an edge case. This allows sourcing the user_info from the access token itself instead of a user_info endpoint. This assumes the access token is a valid JWT with a set of claims to be merged with the id_token.| +|`user_role_field`|string|false||| +|`user_role_mapping`|object|false||| +|`user_roles_default`|array of string|false||| +|`username_field`|string|false||| ## codersdk.OptionType @@ -5001,12 +5001,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------| -| `string` | -| `number` | -| `bool` | -| `list(string)` | +|Value| +|---| +|`string`| +|`number`| +|`bool`| +|`list(string)`| ## codersdk.Organization @@ -5025,16 +5025,16 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|---------|----------|--------------|-------------| -| `created_at` | string | true | | | -| `description` | string | false | | | -| `display_name` | string | false | | | -| `icon` | string | false | | | -| `id` | string | true | | | -| `is_default` | boolean | true | | | -| `name` | string | false | | | -| `updated_at` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|true||| +|`description`|string|false||| +|`display_name`|string|false||| +|`icon`|string|false||| +|`id`|string|true||| +|`is_default`|boolean|true||| +|`name`|string|false||| +|`updated_at`|string|true||| ## codersdk.OrganizationMember @@ -5056,13 +5056,13 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------|-------------------------------------------------|----------|--------------|-------------| -| `created_at` | string | false | | | -| `organization_id` | string | false | | | -| `roles` | array of [codersdk.SlimRole](#codersdkslimrole) | false | | | -| `updated_at` | string | false | | | -| `user_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|false||| +|`organization_id`|string|false||| +|`roles`|array of [codersdk.SlimRole](#codersdkslimrole)|false||| +|`updated_at`|string|false||| +|`user_id`|string|false||| ## codersdk.OrganizationMemberWithUserData @@ -5095,18 +5095,18 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------|-------------------------------------------------|----------|--------------|-------------| -| `avatar_url` | string | false | | | -| `created_at` | string | false | | | -| `email` | string | false | | | -| `global_roles` | array of [codersdk.SlimRole](#codersdkslimrole) | false | | | -| `name` | string | false | | | -| `organization_id` | string | false | | | -| `roles` | array of [codersdk.SlimRole](#codersdkslimrole) | false | | | -| `updated_at` | string | false | | | -| `user_id` | string | false | | | -| `username` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`created_at`|string|false||| +|`email`|string|false||| +|`global_roles`|array of [codersdk.SlimRole](#codersdkslimrole)|false||| +|`name`|string|false||| +|`organization_id`|string|false||| +|`roles`|array of [codersdk.SlimRole](#codersdkslimrole)|false||| +|`updated_at`|string|false||| +|`user_id`|string|false||| +|`username`|string|false||| ## codersdk.OrganizationSyncSettings @@ -5127,12 +5127,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------------|-----------------|----------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `field` | string | false | | Field selects the claim field to be used as the created user's organizations. If the field is the empty string, then no organization updates will ever come from the OIDC provider. | -| `mapping` | object | false | | Mapping maps from an OIDC claim --> Coder organization uuid | -| » `[any property]` | array of string | false | | | -| `organization_assign_default` | boolean | false | | Organization assign default will ensure the default org is always included for every user, regardless of their claims. This preserves legacy behavior. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`field`|string|false||Field selects the claim field to be used as the created user's organizations. If the field is the empty string, then no organization updates will ever come from the OIDC provider.| +|`mapping`|object|false||Mapping maps from an OIDC claim --> Coder organization uuid| +|» `[any property]`|array of string|false||| +|`organization_assign_default`|boolean|false||Organization assign default will ensure the default org is always included for every user, regardless of their claims. This preserves legacy behavior.| ## codersdk.PaginatedMembersResponse @@ -5170,10 +5170,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|---------------------------------------------------------------------------------------------|----------|--------------|-------------| -| `count` | integer | false | | | -| `members` | array of [codersdk.OrganizationMemberWithUserData](#codersdkorganizationmemberwithuserdata) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`count`|integer|false||| +|`members`|array of [codersdk.OrganizationMemberWithUserData](#codersdkorganizationmemberwithuserdata)|false||| ## codersdk.ParameterFormType @@ -5185,19 +5185,19 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------| -| `` | -| `radio` | -| `slider` | -| `input` | -| `dropdown` | -| `checkbox` | -| `switch` | -| `multi-select` | -| `tag-select` | -| `textarea` | -| `error` | +|Value| +|---| +|``| +|`radio`| +|`slider`| +|`input`| +|`dropdown`| +|`checkbox`| +|`switch`| +|`multi-select`| +|`tag-select`| +|`textarea`| +|`error`| ## codersdk.PatchGroupIDPSyncConfigRequest @@ -5211,11 +5211,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|--------------------------------|----------|--------------|-------------| -| `auto_create_missing_groups` | boolean | false | | | -| `field` | string | false | | | -| `regex_filter` | [regexp.Regexp](#regexpregexp) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`auto_create_missing_groups`|boolean|false||| +|`field`|string|false||| +|`regex_filter`|[regexp.Regexp](#regexpregexp)|false||| ## codersdk.PatchGroupIDPSyncMappingRequest @@ -5238,14 +5238,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|-----------------|----------|--------------|----------------------------------------------------------| -| `add` | array of object | false | | | -| `» gets` | string | false | | The ID of the Coder resource the user should be added to | -| `» given` | string | false | | The IdP claim the user has | -| `remove` | array of object | false | | | -| `» gets` | string | false | | The ID of the Coder resource the user should be added to | -| `» given` | string | false | | The IdP claim the user has | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`add`|array of object|false||| +|`» gets`|string|false||The ID of the Coder resource the user should be added to| +|`» given`|string|false||The IdP claim the user has| +|`remove`|array of object|false||| +|`» gets`|string|false||The ID of the Coder resource the user should be added to| +|`» given`|string|false||The IdP claim the user has| ## codersdk.PatchGroupRequest @@ -5266,14 +5266,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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 | | | +|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||| ## codersdk.PatchOrganizationIDPSyncConfigRequest @@ -5286,10 +5286,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|---------|----------|--------------|-------------| -| `assign_default` | boolean | false | | | -| `field` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`assign_default`|boolean|false||| +|`field`|string|false||| ## codersdk.PatchOrganizationIDPSyncMappingRequest @@ -5312,14 +5312,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|-----------------|----------|--------------|----------------------------------------------------------| -| `add` | array of object | false | | | -| `» gets` | string | false | | The ID of the Coder resource the user should be added to | -| `» given` | string | false | | The IdP claim the user has | -| `remove` | array of object | false | | | -| `» gets` | string | false | | The ID of the Coder resource the user should be added to | -| `» given` | string | false | | The IdP claim the user has | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`add`|array of object|false||| +|`» gets`|string|false||The ID of the Coder resource the user should be added to| +|`» given`|string|false||The IdP claim the user has| +|`remove`|array of object|false||| +|`» gets`|string|false||The ID of the Coder resource the user should be added to| +|`» given`|string|false||The IdP claim the user has| ## codersdk.PatchRoleIDPSyncConfigRequest @@ -5331,9 +5331,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|--------|----------|--------------|-------------| -| `field` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`field`|string|false||| ## codersdk.PatchRoleIDPSyncMappingRequest @@ -5356,14 +5356,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|-----------------|----------|--------------|----------------------------------------------------------| -| `add` | array of object | false | | | -| `» gets` | string | false | | The ID of the Coder resource the user should be added to | -| `» given` | string | false | | The IdP claim the user has | -| `remove` | array of object | false | | | -| `» gets` | string | false | | The ID of the Coder resource the user should be added to | -| `» given` | string | false | | The IdP claim the user has | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`add`|array of object|false||| +|`» gets`|string|false||The ID of the Coder resource the user should be added to| +|`» given`|string|false||The IdP claim the user has| +|`remove`|array of object|false||| +|`» gets`|string|false||The ID of the Coder resource the user should be added to| +|`» given`|string|false||The IdP claim the user has| ## codersdk.PatchTemplateVersionRequest @@ -5376,10 +5376,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|--------|----------|--------------|-------------| -| `message` | string | false | | | -| `name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`message`|string|false||| +|`name`|string|false||| ## codersdk.PatchWorkspaceProxy @@ -5395,13 +5395,13 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------|----------|--------------|-------------| -| `display_name` | string | true | | | -| `icon` | string | true | | | -| `id` | string | true | | | -| `name` | string | true | | | -| `regenerate_token` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|true||| +|`icon`|string|true||| +|`id`|string|true||| +|`name`|string|true||| +|`regenerate_token`|boolean|false||| ## codersdk.Permission @@ -5415,11 +5415,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|------------------------------------------------|----------|--------------|-----------------------------------------| -| `action` | [codersdk.RBACAction](#codersdkrbacaction) | false | | | -| `negate` | boolean | false | | Negate makes this a negative permission | -| `resource_type` | [codersdk.RBACResource](#codersdkrbacresource) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`action`|[codersdk.RBACAction](#codersdkrbacaction)|false||| +|`negate`|boolean|false||Negate makes this a negative permission| +|`resource_type`|[codersdk.RBACResource](#codersdkrbacresource)|false||| ## codersdk.PostOAuth2ProviderAppRequest @@ -5433,11 +5433,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `callback_url` | string | true | | | -| `icon` | string | false | | | -| `name` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`callback_url`|string|true||| +|`icon`|string|false||| +|`name`|string|true||| ## codersdk.PostWorkspaceUsageRequest @@ -5450,10 +5450,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|------------------------------------------------|----------|--------------|-------------| -| `agent_id` | string | false | | | -| `app_name` | [codersdk.UsageAppName](#codersdkusageappname) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`agent_id`|string|false||| +|`app_name`|[codersdk.UsageAppName](#codersdkusageappname)|false||| ## codersdk.PprofConfig @@ -5469,10 +5469,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|--------------------------------------|----------|--------------|-------------| -| `address` | [serpent.HostPort](#serpenthostport) | false | | | -| `enable` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`address`|[serpent.HostPort](#serpenthostport)|false||| +|`enable`|boolean|false||| ## codersdk.PrebuildsConfig @@ -5487,12 +5487,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------------------------|---------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `failure_hard_limit` | integer | false | | Failure hard limit defines the maximum number of consecutive failed prebuild attempts allowed before a preset is considered to be in a hard limit state. When a preset hits this limit, no new prebuilds will be created until the limit is reset. FailureHardLimit is disabled when set to zero. | -| `reconciliation_backoff_interval` | integer | false | | Reconciliation backoff interval specifies the amount of time to increase the backoff interval when errors occur during reconciliation. | -| `reconciliation_backoff_lookback` | integer | false | | Reconciliation backoff lookback determines the time window to look back when calculating the number of failed prebuilds, which influences the backoff strategy. | -| `reconciliation_interval` | integer | false | | Reconciliation interval defines how often the workspace prebuilds state should be reconciled. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`failure_hard_limit`|integer|false||Failure hard limit defines the maximum number of consecutive failed prebuild attempts allowed before a preset is considered to be in a hard limit state. When a preset hits this limit, no new prebuilds will be created until the limit is reset. FailureHardLimit is disabled when set to zero.| +|`reconciliation_backoff_interval`|integer|false||Reconciliation backoff interval specifies the amount of time to increase the backoff interval when errors occur during reconciliation.| +|`reconciliation_backoff_lookback`|integer|false||Reconciliation backoff lookback determines the time window to look back when calculating the number of failed prebuilds, which influences the backoff strategy.| +|`reconciliation_interval`|integer|false||Reconciliation interval defines how often the workspace prebuilds state should be reconciled.| ## codersdk.PrebuildsSettings @@ -5504,9 +5504,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------|---------|----------|--------------|-------------| -| `reconciliation_paused` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`reconciliation_paused`|boolean|false||| ## codersdk.Preset @@ -5550,10 +5550,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|--------|----------|--------------|-------------| -| `name` | string | false | | | -| `value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`name`|string|false||| +|`value`|string|false||| ## codersdk.PreviewParameter @@ -5618,24 +5618,24 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|-------------------------------------------------------------------------------------|----------|--------------|-----------------------------------------| -| `default_value` | [codersdk.NullHCLString](#codersdknullhclstring) | false | | | -| `description` | string | false | | | -| `diagnostics` | array of [codersdk.FriendlyDiagnostic](#codersdkfriendlydiagnostic) | false | | | -| `display_name` | string | false | | | -| `ephemeral` | boolean | false | | | -| `form_type` | [codersdk.ParameterFormType](#codersdkparameterformtype) | false | | | -| `icon` | string | false | | | -| `mutable` | boolean | false | | | -| `name` | string | false | | | -| `options` | array of [codersdk.PreviewParameterOption](#codersdkpreviewparameteroption) | false | | | -| `order` | integer | false | | legacy_variable_name was removed (= 14) | -| `required` | boolean | false | | | -| `styling` | [codersdk.PreviewParameterStyling](#codersdkpreviewparameterstyling) | false | | | -| `type` | [codersdk.OptionType](#codersdkoptiontype) | false | | | -| `validations` | array of [codersdk.PreviewParameterValidation](#codersdkpreviewparametervalidation) | false | | | -| `value` | [codersdk.NullHCLString](#codersdknullhclstring) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`default_value`|[codersdk.NullHCLString](#codersdknullhclstring)|false||| +|`description`|string|false||| +|`diagnostics`|array of [codersdk.FriendlyDiagnostic](#codersdkfriendlydiagnostic)|false||| +|`display_name`|string|false||| +|`ephemeral`|boolean|false||| +|`form_type`|[codersdk.ParameterFormType](#codersdkparameterformtype)|false||| +|`icon`|string|false||| +|`mutable`|boolean|false||| +|`name`|string|false||| +|`options`|array of [codersdk.PreviewParameterOption](#codersdkpreviewparameteroption)|false||| +|`order`|integer|false||legacy_variable_name was removed (= 14)| +|`required`|boolean|false||| +|`styling`|[codersdk.PreviewParameterStyling](#codersdkpreviewparameterstyling)|false||| +|`type`|[codersdk.OptionType](#codersdkoptiontype)|false||| +|`validations`|array of [codersdk.PreviewParameterValidation](#codersdkpreviewparametervalidation)|false||| +|`value`|[codersdk.NullHCLString](#codersdknullhclstring)|false||| ## codersdk.PreviewParameterOption @@ -5653,12 +5653,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|--------------------------------------------------|----------|--------------|-------------| -| `description` | string | false | | | -| `icon` | string | false | | | -| `name` | string | false | | | -| `value` | [codersdk.NullHCLString](#codersdknullhclstring) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`description`|string|false||| +|`icon`|string|false||| +|`name`|string|false||| +|`value`|[codersdk.NullHCLString](#codersdknullhclstring)|false||| ## codersdk.PreviewParameterStyling @@ -5673,12 +5673,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|---------|----------|--------------|-------------| -| `disabled` | boolean | false | | | -| `label` | string | false | | | -| `mask_input` | boolean | false | | | -| `placeholder` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`disabled`|boolean|false||| +|`label`|string|false||| +|`mask_input`|boolean|false||| +|`placeholder`|string|false||| ## codersdk.PreviewParameterValidation @@ -5694,13 +5694,13 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|---------|----------|--------------|-----------------------------------------| -| `validation_error` | string | false | | | -| `validation_max` | integer | false | | | -| `validation_min` | integer | false | | | -| `validation_monotonic` | string | false | | | -| `validation_regex` | string | false | | All validation attributes are optional. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`validation_error`|string|false||| +|`validation_max`|integer|false||| +|`validation_min`|integer|false||| +|`validation_monotonic`|string|false||| +|`validation_regex`|string|false||All validation attributes are optional.| ## codersdk.PrometheusConfig @@ -5721,13 +5721,13 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------------|--------------------------------------|----------|--------------|-------------| -| `address` | [serpent.HostPort](#serpenthostport) | false | | | -| `aggregate_agent_stats_by` | array of string | false | | | -| `collect_agent_stats` | boolean | false | | | -| `collect_db_metrics` | boolean | false | | | -| `enable` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`address`|[serpent.HostPort](#serpenthostport)|false||| +|`aggregate_agent_stats_by`|array of string|false||| +|`collect_agent_stats`|boolean|false||| +|`collect_db_metrics`|boolean|false||| +|`enable`|boolean|false||| ## codersdk.ProvisionerConfig @@ -5746,14 +5746,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------|-----------------|----------|--------------|-----------------------------------------------------------| -| `daemon_poll_interval` | integer | false | | | -| `daemon_poll_jitter` | integer | false | | | -| `daemon_psk` | string | false | | | -| `daemon_types` | array of string | false | | | -| `daemons` | integer | false | | Daemons is the number of built-in terraform provisioners. | -| `force_cancel_interval` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`daemon_poll_interval`|integer|false||| +|`daemon_poll_jitter`|integer|false||| +|`daemon_psk`|string|false||| +|`daemon_types`|array of string|false||| +|`daemons`|integer|false||Daemons is the number of built-in terraform provisioners.| +|`force_cancel_interval`|integer|false||| ## codersdk.ProvisionerDaemon @@ -5795,31 +5795,31 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|----------------------------------------------------------------------|----------|--------------|------------------| -| `api_version` | string | false | | | -| `created_at` | string | false | | | -| `current_job` | [codersdk.ProvisionerDaemonJob](#codersdkprovisionerdaemonjob) | false | | | -| `id` | string | false | | | -| `key_id` | string | false | | | -| `key_name` | string | false | | Optional fields. | -| `last_seen_at` | string | false | | | -| `name` | string | false | | | -| `organization_id` | string | false | | | -| `previous_job` | [codersdk.ProvisionerDaemonJob](#codersdkprovisionerdaemonjob) | false | | | -| `provisioners` | array of string | false | | | -| `status` | [codersdk.ProvisionerDaemonStatus](#codersdkprovisionerdaemonstatus) | false | | | -| `tags` | object | false | | | -| » `[any property]` | string | false | | | -| `version` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`api_version`|string|false||| +|`created_at`|string|false||| +|`current_job`|[codersdk.ProvisionerDaemonJob](#codersdkprovisionerdaemonjob)|false||| +|`id`|string|false||| +|`key_id`|string|false||| +|`key_name`|string|false||Optional fields.| +|`last_seen_at`|string|false||| +|`name`|string|false||| +|`organization_id`|string|false||| +|`previous_job`|[codersdk.ProvisionerDaemonJob](#codersdkprovisionerdaemonjob)|false||| +|`provisioners`|array of string|false||| +|`status`|[codersdk.ProvisionerDaemonStatus](#codersdkprovisionerdaemonstatus)|false||| +|`tags`|object|false||| +|» `[any property]`|string|false||| +|`version`|string|false||| #### Enumerated Values -| Property | Value | -|----------|-----------| -| `status` | `offline` | -| `status` | `idle` | -| `status` | `busy` | +|Property|Value| +|---|---| +|`status`|`offline`| +|`status`|`idle`| +|`status`|`busy`| ## codersdk.ProvisionerDaemonJob @@ -5835,24 +5835,24 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------|----------------------------------------------------------------|----------|--------------|-------------| -| `id` | string | false | | | -| `status` | [codersdk.ProvisionerJobStatus](#codersdkprovisionerjobstatus) | false | | | -| `template_display_name` | string | false | | | -| `template_icon` | string | false | | | -| `template_name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`id`|string|false||| +|`status`|[codersdk.ProvisionerJobStatus](#codersdkprovisionerjobstatus)|false||| +|`template_display_name`|string|false||| +|`template_icon`|string|false||| +|`template_name`|string|false||| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | +|Property|Value| +|---|---| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| ## codersdk.ProvisionerDaemonStatus @@ -5864,11 +5864,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-----------| -| `offline` | -| `idle` | -| `busy` | +|Value| +|---| +|`offline`| +|`idle`| +|`busy`| ## codersdk.ProvisionerJob @@ -5915,40 +5915,40 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|--------------------------------------------------------------------|----------|--------------|-------------| -| `available_workers` | array of string | false | | | -| `canceled_at` | string | false | | | -| `completed_at` | string | false | | | -| `created_at` | string | false | | | -| `error` | string | false | | | -| `error_code` | [codersdk.JobErrorCode](#codersdkjoberrorcode) | false | | | -| `file_id` | string | false | | | -| `id` | string | false | | | -| `input` | [codersdk.ProvisionerJobInput](#codersdkprovisionerjobinput) | false | | | -| `metadata` | [codersdk.ProvisionerJobMetadata](#codersdkprovisionerjobmetadata) | false | | | -| `organization_id` | string | false | | | -| `queue_position` | integer | false | | | -| `queue_size` | integer | false | | | -| `started_at` | string | false | | | -| `status` | [codersdk.ProvisionerJobStatus](#codersdkprovisionerjobstatus) | false | | | -| `tags` | object | false | | | -| » `[any property]` | string | false | | | -| `type` | [codersdk.ProvisionerJobType](#codersdkprovisionerjobtype) | false | | | -| `worker_id` | string | false | | | -| `worker_name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`available_workers`|array of string|false||| +|`canceled_at`|string|false||| +|`completed_at`|string|false||| +|`created_at`|string|false||| +|`error`|string|false||| +|`error_code`|[codersdk.JobErrorCode](#codersdkjoberrorcode)|false||| +|`file_id`|string|false||| +|`id`|string|false||| +|`input`|[codersdk.ProvisionerJobInput](#codersdkprovisionerjobinput)|false||| +|`metadata`|[codersdk.ProvisionerJobMetadata](#codersdkprovisionerjobmetadata)|false||| +|`organization_id`|string|false||| +|`queue_position`|integer|false||| +|`queue_size`|integer|false||| +|`started_at`|string|false||| +|`status`|[codersdk.ProvisionerJobStatus](#codersdkprovisionerjobstatus)|false||| +|`tags`|object|false||| +|» `[any property]`|string|false||| +|`type`|[codersdk.ProvisionerJobType](#codersdkprovisionerjobtype)|false||| +|`worker_id`|string|false||| +|`worker_name`|string|false||| #### Enumerated Values -| Property | Value | -|--------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | +|Property|Value| +|---|---| +|`error_code`|`REQUIRED_TEMPLATE_VARIABLES`| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| ## codersdk.ProvisionerJobInput @@ -5962,11 +5962,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------------|--------|----------|--------------|-------------| -| `error` | string | false | | | -| `template_version_id` | string | false | | | -| `workspace_build_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`error`|string|false||| +|`template_version_id`|string|false||| +|`workspace_build_id`|string|false||| ## codersdk.ProvisionerJobLog @@ -5983,24 +5983,24 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| 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 | | | +|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||| #### Enumerated Values -| Property | Value | -|-------------|---------| -| `log_level` | `trace` | -| `log_level` | `debug` | -| `log_level` | `info` | -| `log_level` | `warn` | -| `log_level` | `error` | +|Property|Value| +|---|---| +|`log_level`|`trace`| +|`log_level`|`debug`| +|`log_level`|`info`| +|`log_level`|`warn`| +|`log_level`|`error`| ## codersdk.ProvisionerJobMetadata @@ -6018,15 +6018,15 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------|--------|----------|--------------|-------------| -| `template_display_name` | string | false | | | -| `template_icon` | string | false | | | -| `template_id` | string | false | | | -| `template_name` | string | false | | | -| `template_version_name` | string | false | | | -| `workspace_id` | string | false | | | -| `workspace_name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`template_display_name`|string|false||| +|`template_icon`|string|false||| +|`template_id`|string|false||| +|`template_name`|string|false||| +|`template_version_name`|string|false||| +|`workspace_id`|string|false||| +|`workspace_name`|string|false||| ## codersdk.ProvisionerJobStatus @@ -6038,15 +6038,15 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-------------| -| `pending` | -| `running` | -| `succeeded` | -| `canceling` | -| `canceled` | -| `failed` | -| `unknown` | +|Value| +|---| +|`pending`| +|`running`| +|`succeeded`| +|`canceling`| +|`canceled`| +|`failed`| +|`unknown`| ## codersdk.ProvisionerJobType @@ -6058,11 +6058,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------------------| -| `template_version_import` | -| `workspace_build` | -| `template_version_dry_run` | +|Value| +|---| +|`template_version_import`| +|`workspace_build`| +|`template_version_dry_run`| ## codersdk.ProvisionerKey @@ -6081,13 +6081,13 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|------------------------------------------------------------|----------|--------------|-------------| -| `created_at` | string | false | | | -| `id` | string | false | | | -| `name` | string | false | | | -| `organization` | string | false | | | -| `tags` | [codersdk.ProvisionerKeyTags](#codersdkprovisionerkeytags) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|false||| +|`id`|string|false||| +|`name`|string|false||| +|`organization`|string|false||| +|`tags`|[codersdk.ProvisionerKeyTags](#codersdkprovisionerkeytags)|false||| ## codersdk.ProvisionerKeyDaemons @@ -6143,10 +6143,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|-------------------------------------------------------------------|----------|--------------|-------------| -| `daemons` | array of [codersdk.ProvisionerDaemon](#codersdkprovisionerdaemon) | false | | | -| `key` | [codersdk.ProvisionerKey](#codersdkprovisionerkey) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`daemons`|array of [codersdk.ProvisionerDaemon](#codersdkprovisionerdaemon)|false||| +|`key`|[codersdk.ProvisionerKey](#codersdkprovisionerkey)|false||| ## codersdk.ProvisionerKeyTags @@ -6159,9 +6159,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|--------|----------|--------------|-------------| -| `[any property]` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[any property]`|string|false||| ## codersdk.ProvisionerLogLevel @@ -6173,9 +6173,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|---------| -| `debug` | +|Value| +|---| +|`debug`| ## codersdk.ProvisionerStorageMethod @@ -6187,9 +6187,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|--------| -| `file` | +|Value| +|---| +|`file`| ## codersdk.ProvisionerTiming @@ -6207,15 +6207,15 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|----------------------------------------------|----------|--------------|-------------| -| `action` | string | false | | | -| `ended_at` | string | false | | | -| `job_id` | string | false | | | -| `resource` | string | false | | | -| `source` | string | false | | | -| `stage` | [codersdk.TimingStage](#codersdktimingstage) | false | | | -| `started_at` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`action`|string|false||| +|`ended_at`|string|false||| +|`job_id`|string|false||| +|`resource`|string|false||| +|`source`|string|false||| +|`stage`|[codersdk.TimingStage](#codersdktimingstage)|false||| +|`started_at`|string|false||| ## codersdk.ProxyHealthReport @@ -6232,10 +6232,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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. | +|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 @@ -6247,12 +6247,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------| -| `ok` | -| `unreachable` | -| `unhealthy` | -| `unregistered` | +|Value| +|---| +|`ok`| +|`unreachable`| +|`unhealthy`| +|`unregistered`| ## codersdk.PutExtendWorkspaceRequest @@ -6264,9 +6264,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|--------|----------|--------------|-------------| -| `deadline` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`deadline`|string|true||| ## codersdk.PutOAuth2ProviderAppRequest @@ -6280,11 +6280,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `callback_url` | string | true | | | -| `icon` | string | false | | | -| `name` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`callback_url`|string|true||| +|`icon`|string|false||| +|`name`|string|true||| ## codersdk.RBACAction @@ -6296,24 +6296,24 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-----------------------| -| `application_connect` | -| `assign` | -| `create` | -| `create_agent` | -| `delete` | -| `delete_agent` | -| `read` | -| `read_personal` | -| `ssh` | -| `unassign` | -| `update` | -| `update_personal` | -| `use` | -| `view_insights` | -| `start` | -| `stop` | +|Value| +|---| +|`application_connect`| +|`assign`| +|`create`| +|`create_agent`| +|`delete`| +|`delete_agent`| +|`read`| +|`read_personal`| +|`ssh`| +|`unassign`| +|`update`| +|`update_personal`| +|`use`| +|`view_insights`| +|`start`| +|`stop`| ## codersdk.RBACResource @@ -6325,46 +6325,46 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|------------------------------------| -| `*` | -| `api_key` | -| `assign_org_role` | -| `assign_role` | -| `audit_log` | -| `connection_log` | -| `crypto_key` | -| `debug_info` | -| `deployment_config` | -| `deployment_stats` | -| `file` | -| `group` | -| `group_member` | -| `idpsync_settings` | -| `inbox_notification` | -| `license` | -| `notification_message` | -| `notification_preference` | -| `notification_template` | -| `oauth2_app` | -| `oauth2_app_code_token` | -| `oauth2_app_secret` | -| `organization` | -| `organization_member` | -| `prebuilt_workspace` | -| `provisioner_daemon` | -| `provisioner_jobs` | -| `replicas` | -| `system` | -| `tailnet_coordinator` | -| `template` | -| `user` | -| `webpush_subscription` | -| `workspace` | -| `workspace_agent_devcontainers` | -| `workspace_agent_resource_monitor` | -| `workspace_dormant` | -| `workspace_proxy` | +|Value| +|---| +|`*`| +|`api_key`| +|`assign_org_role`| +|`assign_role`| +|`audit_log`| +|`connection_log`| +|`crypto_key`| +|`debug_info`| +|`deployment_config`| +|`deployment_stats`| +|`file`| +|`group`| +|`group_member`| +|`idpsync_settings`| +|`inbox_notification`| +|`license`| +|`notification_message`| +|`notification_preference`| +|`notification_template`| +|`oauth2_app`| +|`oauth2_app_code_token`| +|`oauth2_app_secret`| +|`organization`| +|`organization_member`| +|`prebuilt_workspace`| +|`provisioner_daemon`| +|`provisioner_jobs`| +|`replicas`| +|`system`| +|`tailnet_coordinator`| +|`template`| +|`user`| +|`webpush_subscription`| +|`workspace`| +|`workspace_agent_devcontainers`| +|`workspace_agent_resource_monitor`| +|`workspace_dormant`| +|`workspace_proxy`| ## codersdk.RateLimitConfig @@ -6377,10 +6377,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|---------|----------|--------------|-------------| -| `api` | integer | false | | | -| `disable_all` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`api`|integer|false||| +|`disable_all`|boolean|false||| ## codersdk.ReducedUser @@ -6402,26 +6402,26 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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 | | | -| `login_type` | [codersdk.LoginType](#codersdklogintype) | false | | | -| `name` | string | false | | | -| `status` | [codersdk.UserStatus](#codersdkuserstatus) | false | | | -| `theme_preference` | string | false | | Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead. | -| `updated_at` | string | false | | | -| `username` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`created_at`|string|true||| +|`email`|string|true||| +|`id`|string|true||| +|`last_seen_at`|string|false||| +|`login_type`|[codersdk.LoginType](#codersdklogintype)|false||| +|`name`|string|false||| +|`status`|[codersdk.UserStatus](#codersdkuserstatus)|false||| +|`theme_preference`|string|false||Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead.| +|`updated_at`|string|false||| +|`username`|string|true||| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `active` | -| `status` | `suspended` | +|Property|Value| +|---|---| +|`status`|`active`| +|`status`|`suspended`| ## codersdk.Region @@ -6439,15 +6439,15 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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. | +|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.| ## codersdk.RegionsResponse-codersdk_Region @@ -6469,9 +6469,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|---------------------------------------------|----------|--------------|-------------| -| `regions` | array of [codersdk.Region](#codersdkregion) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`regions`|array of [codersdk.Region](#codersdkregion)|false||| ## codersdk.RegionsResponse-codersdk_WorkspaceProxy @@ -6511,9 +6511,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|-------------------------------------------------------------|----------|--------------|-------------| -| `regions` | array of [codersdk.WorkspaceProxy](#codersdkworkspaceproxy) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`regions`|array of [codersdk.WorkspaceProxy](#codersdkworkspaceproxy)|false||| ## codersdk.Replica @@ -6531,15 +6531,15 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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. | +|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.| ## codersdk.RequestOneTimePasscodeRequest @@ -6551,9 +6551,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|--------|----------|--------------|-------------| -| `email` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`email`|string|true||| ## codersdk.ResolveAutostartResponse @@ -6565,9 +6565,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|---------|----------|--------------|-------------| -| `parameter_mismatch` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`parameter_mismatch`|boolean|false||| ## codersdk.ResourceType @@ -6579,33 +6579,33 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------------------------| -| `template` | -| `template_version` | -| `user` | -| `workspace` | -| `workspace_build` | -| `git_ssh_key` | -| `api_key` | -| `group` | -| `license` | -| `convert_login` | -| `health_settings` | -| `notifications_settings` | -| `prebuilds_settings` | -| `workspace_proxy` | -| `organization` | -| `oauth2_provider_app` | -| `oauth2_provider_app_secret` | -| `custom_role` | -| `organization_member` | -| `notification_template` | -| `idp_sync_settings_organization` | -| `idp_sync_settings_group` | -| `idp_sync_settings_role` | -| `workspace_agent` | -| `workspace_app` | +|Value| +|---| +|`template`| +|`template_version`| +|`user`| +|`workspace`| +|`workspace_build`| +|`git_ssh_key`| +|`api_key`| +|`group`| +|`license`| +|`convert_login`| +|`health_settings`| +|`notifications_settings`| +|`prebuilds_settings`| +|`workspace_proxy`| +|`organization`| +|`oauth2_provider_app`| +|`oauth2_provider_app_secret`| +|`custom_role`| +|`organization_member`| +|`notification_template`| +|`idp_sync_settings_organization`| +|`idp_sync_settings_group`| +|`idp_sync_settings_role`| +|`workspace_agent`| +|`workspace_app`| ## codersdk.Response @@ -6624,11 +6624,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| 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'. | +|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'.| ## codersdk.Role @@ -6663,14 +6663,14 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------------|-----------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------| -| `display_name` | string | false | | | -| `name` | string | false | | | -| `organization_id` | string | false | | | -| `organization_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | Organization permissions are specific for the organization in the field 'OrganizationID' above. | -| `site_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | | -| `user_permissions` | array of [codersdk.Permission](#codersdkpermission) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|false||| +|`name`|string|false||| +|`organization_id`|string|false||| +|`organization_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||Organization permissions are specific for the organization in the field 'OrganizationID' above.| +|`site_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||| +|`user_permissions`|array of [codersdk.Permission](#codersdkpermission)|false||| ## codersdk.RoleSyncSettings @@ -6690,11 +6690,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|-----------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------| -| `field` | string | false | | Field is the name of the claim field that specifies what organization roles a user should be given. If empty, no roles will be synced. | -| `mapping` | object | false | | Mapping is a map from OIDC groups to Coder organization roles. | -| » `[any property]` | array of string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`field`|string|false||Field is the name of the claim field that specifies what organization roles a user should be given. If empty, no roles will be synced.| +|`mapping`|object|false||Mapping is a map from OIDC groups to Coder organization roles.| +|» `[any property]`|array of string|false||| ## codersdk.SSHConfig @@ -6709,10 +6709,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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. | +|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 @@ -6729,12 +6729,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|--------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------| -| `hostname_prefix` | string | false | | Hostname prefix is the prefix we append to workspace names for SSH hostnames. Deprecated: use HostnameSuffix instead. | -| `hostname_suffix` | string | false | | Hostname suffix is the suffix to append to workspace names for SSH hostnames. | -| `ssh_config_options` | object | false | | | -| » `[any property]` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`hostname_prefix`|string|false||Hostname prefix is the prefix we append to workspace names for SSH hostnames. Deprecated: use HostnameSuffix instead.| +|`hostname_suffix`|string|false||Hostname suffix is the suffix to append to workspace names for SSH hostnames.| +|`ssh_config_options`|object|false||| +|» `[any property]`|string|false||| ## codersdk.ServerSentEvent @@ -6747,10 +6747,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------|--------------------------------------------------------------|----------|--------------|-------------| -| `data` | any | false | | | -| `type` | [codersdk.ServerSentEventType](#codersdkserversenteventtype) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`data`|any|false||| +|`type`|[codersdk.ServerSentEventType](#codersdkserversenteventtype)|false||| ## codersdk.ServerSentEventType @@ -6762,11 +6762,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|---------| -| `ping` | -| `data` | -| `error` | +|Value| +|---| +|`ping`| +|`data`| +|`error`| ## codersdk.SessionCountDeploymentStats @@ -6781,12 +6781,12 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------|----------|--------------|-------------| -| `jetbrains` | integer | false | | | -| `reconnecting_pty` | integer | false | | | -| `ssh` | integer | false | | | -| `vscode` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`jetbrains`|integer|false||| +|`reconnecting_pty`|integer|false||| +|`ssh`|integer|false||| +|`vscode`|integer|false||| ## codersdk.SessionLifetime @@ -6802,13 +6802,13 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------------|---------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `default_duration` | integer | false | | Default duration is only for browser, workspace app and oauth sessions. | -| `default_token_lifetime` | integer | false | | | -| `disable_expiry_refresh` | boolean | false | | Disable expiry refresh will disable automatically refreshing api keys when they are used from the api. This means the api key lifetime at creation is the lifetime of the api key. | -| `max_admin_token_lifetime` | integer | false | | | -| `max_token_lifetime` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`default_duration`|integer|false||Default duration is only for browser, workspace app and oauth sessions.| +|`default_token_lifetime`|integer|false||| +|`disable_expiry_refresh`|boolean|false||Disable expiry refresh will disable automatically refreshing api keys when they are used from the api. This means the api key lifetime at creation is the lifetime of the api key.| +|`max_admin_token_lifetime`|integer|false||| +|`max_token_lifetime`|integer|false||| ## codersdk.SlimRole @@ -6822,11 +6822,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------|--------|----------|--------------|-------------| -| `display_name` | string | false | | | -| `name` | string | false | | | -| `organization_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|false||| +|`name`|string|false||| +|`organization_id`|string|false||| ## codersdk.SupportConfig @@ -6846,9 +6846,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|--------------------------------------------------------------------------------------|----------|--------------|-------------| -| `links` | [serpent.Struct-array_codersdk_LinkConfig](#serpentstruct-array_codersdk_linkconfig) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`links`|[serpent.Struct-array_codersdk_LinkConfig](#serpentstruct-array_codersdk_linkconfig)|false||| ## codersdk.SwaggerConfig @@ -6860,9 +6860,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|---------|----------|--------------|-------------| -| `enable` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`enable`|boolean|false||| ## codersdk.TLSConfig @@ -6894,20 +6894,20 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------------|--------------------------------------|----------|--------------|-------------| -| `address` | [serpent.HostPort](#serpenthostport) | 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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`address`|[serpent.HostPort](#serpenthostport)|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||| ## codersdk.TelemetryConfig @@ -6933,11 +6933,11 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|----------------------------|----------|--------------|-------------| -| `enable` | boolean | false | | | -| `trace` | boolean | false | | | -| `url` | [serpent.URL](#serpenturl) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`enable`|boolean|false||| +|`trace`|boolean|false||| +|`url`|[serpent.URL](#serpenturl)|false||| ## codersdk.Template @@ -6998,46 +6998,46 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------------|--------------------------------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `active_user_count` | integer | false | | Active user count is set to -1 when loading. | -| `active_version_id` | string | false | | | -| `activity_bump_ms` | integer | false | | | -| `allow_user_autostart` | boolean | false | | Allow user autostart and AllowUserAutostop are enterprise-only. Their values are only used if your license is entitled to use the advanced template scheduling feature. | -| `allow_user_autostop` | boolean | false | | | -| `allow_user_cancel_workspace_jobs` | boolean | false | | | -| `autostart_requirement` | [codersdk.TemplateAutostartRequirement](#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 | | | -| `deprecated` | boolean | false | | | -| `deprecation_message` | string | false | | | -| `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 | | | -| `max_port_share_level` | [codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel) | false | | | -| `name` | string | false | | | -| `organization_display_name` | string | false | | | -| `organization_icon` | string | false | | | -| `organization_id` | string | false | | | -| `organization_name` | string | false | | | -| `provisioner` | string | false | | | -| `require_active_version` | boolean | false | | Require active version mandates that workspaces are built with the active template version. | -| `time_til_dormant_autodelete_ms` | integer | false | | | -| `time_til_dormant_ms` | integer | false | | | -| `updated_at` | string | false | | | -| `use_classic_parameter_flow` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`active_user_count`|integer|false||Active user count is set to -1 when loading.| +|`active_version_id`|string|false||| +|`activity_bump_ms`|integer|false||| +|`allow_user_autostart`|boolean|false||Allow user autostart and AllowUserAutostop are enterprise-only. Their values are only used if your license is entitled to use the advanced template scheduling feature.| +|`allow_user_autostop`|boolean|false||| +|`allow_user_cancel_workspace_jobs`|boolean|false||| +|`autostart_requirement`|[codersdk.TemplateAutostartRequirement](#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||| +|`deprecated`|boolean|false||| +|`deprecation_message`|string|false||| +|`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||| +|`max_port_share_level`|[codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel)|false||| +|`name`|string|false||| +|`organization_display_name`|string|false||| +|`organization_icon`|string|false||| +|`organization_id`|string|false||| +|`organization_name`|string|false||| +|`provisioner`|string|false||| +|`require_active_version`|boolean|false||Require active version mandates that workspaces are built with the active template version.| +|`time_til_dormant_autodelete_ms`|integer|false||| +|`time_til_dormant_ms`|integer|false||| +|`updated_at`|string|false||| +|`use_classic_parameter_flow`|boolean|false||| #### Enumerated Values -| Property | Value | -|---------------|-------------| -| `provisioner` | `terraform` | +|Property|Value| +|---|---| +|`provisioner`|`terraform`| ## codersdk.TemplateACL @@ -7104,10 +7104,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|-----------------------------------------------------------|----------|--------------|-------------| -| `group` | array of [codersdk.TemplateGroup](#codersdktemplategroup) | false | | | -| `users` | array of [codersdk.TemplateUser](#codersdktemplateuser) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`group`|array of [codersdk.TemplateGroup](#codersdktemplategroup)|false||| +|`users`|array of [codersdk.TemplateUser](#codersdktemplateuser)|false||| ## codersdk.TemplateAppUsage @@ -7127,15 +7127,15 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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 | | | -| `times_used` | integer | false | | | -| `type` | [codersdk.TemplateAppsType](#codersdktemplateappstype) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`display_name`|string|false||| +|`icon`|string|false||| +|`seconds`|integer|false||| +|`slug`|string|false||| +|`template_ids`|array of string|false||| +|`times_used`|integer|false||| +|`type`|[codersdk.TemplateAppsType](#codersdktemplateappstype)|false||| ## codersdk.TemplateAppsType @@ -7147,10 +7147,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-----------| -| `builtin` | -| `app` | +|Value| +|---| +|`builtin`| +|`app`| ## codersdk.TemplateAutostartRequirement @@ -7164,9 +7164,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| ### 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. | +|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.| ## codersdk.TemplateAutostopRequirement @@ -7204,9 +7204,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|------------------------------------------------------|----------|--------------|-------------| -| `[any property]` | [codersdk.TransitionStats](#codersdktransitionstats) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[any property]`|[codersdk.TransitionStats](#codersdktransitionstats)|false||| ## codersdk.TemplateExample @@ -7226,15 +7226,15 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### 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 | | | +|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||| ## codersdk.TemplateGroup @@ -7271,27 +7271,27 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------------------|-------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `avatar_url` | string | false | | | -| `display_name` | string | false | | | -| `id` | string | false | | | -| `members` | array of [codersdk.ReducedUser](#codersdkreduceduser) | false | | | -| `name` | string | false | | | -| `organization_display_name` | string | false | | | -| `organization_id` | string | false | | | -| `organization_name` | string | false | | | -| `quota_allowance` | integer | false | | | -| `role` | [codersdk.TemplateRole](#codersdktemplaterole) | false | | | -| `source` | [codersdk.GroupSource](#codersdkgroupsource) | false | | | -| `total_member_count` | integer | false | | How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`display_name`|string|false||| +|`id`|string|false||| +|`members`|array of [codersdk.ReducedUser](#codersdkreduceduser)|false||| +|`name`|string|false||| +|`organization_display_name`|string|false||| +|`organization_id`|string|false||| +|`organization_name`|string|false||| +|`quota_allowance`|integer|false||| +|`role`|[codersdk.TemplateRole](#codersdktemplaterole)|false||| +|`source`|[codersdk.GroupSource](#codersdkgroupsource)|false||| +|`total_member_count`|integer|false||How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than `len(Group.Members)`.| #### Enumerated Values -| Property | Value | -|----------|---------| -| `role` | `admin` | -| `role` | `use` | +|Property|Value| +|---|---| +|`role`|`admin`| +|`role`|`use`| ## codersdk.TemplateInsightsIntervalReport @@ -7309,13 +7309,13 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### 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 | | | +|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 @@ -7370,14 +7370,14 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| 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 | | | +|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||| ## codersdk.TemplateInsightsResponse @@ -7445,10 +7445,10 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------------------------------------------------------------------------------------------|----------|--------------|-------------| -| `interval_reports` | array of [codersdk.TemplateInsightsIntervalReport](#codersdktemplateinsightsintervalreport) | false | | | -| `report` | [codersdk.TemplateInsightsReport](#codersdktemplateinsightsreport) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`interval_reports`|array of [codersdk.TemplateInsightsIntervalReport](#codersdktemplateinsightsintervalreport)|false||| +|`report`|[codersdk.TemplateInsightsReport](#codersdktemplateinsightsreport)|false||| ## codersdk.TemplateParameterUsage @@ -7480,15 +7480,15 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|---------------------------------------------------------------------------------------------|----------|--------------|-------------| -| `description` | string | false | | | -| `display_name` | string | false | | | -| `name` | string | false | | | -| `options` | array of [codersdk.TemplateVersionParameterOption](#codersdktemplateversionparameteroption) | false | | | -| `template_ids` | array of string | false | | | -| `type` | string | false | | | -| `values` | array of [codersdk.TemplateParameterValue](#codersdktemplateparametervalue) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`description`|string|false||| +|`display_name`|string|false||| +|`name`|string|false||| +|`options`|array of [codersdk.TemplateVersionParameterOption](#codersdktemplateversionparameteroption)|false||| +|`template_ids`|array of string|false||| +|`type`|string|false||| +|`values`|array of [codersdk.TemplateParameterValue](#codersdktemplateparametervalue)|false||| ## codersdk.TemplateParameterValue @@ -7501,10 +7501,10 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|---------|----------|--------------|-------------| -| `count` | integer | false | | | -| `value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`count`|integer|false||| +|`value`|string|false||| ## codersdk.TemplateRole @@ -7516,11 +7516,11 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Value | -|---------| -| `admin` | -| `use` | -| `` | +|Value| +|---| +|`admin`| +|`use`| +|``| ## codersdk.TemplateUser @@ -7553,31 +7553,31 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### 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 | | | -| `login_type` | [codersdk.LoginType](#codersdklogintype) | false | | | -| `name` | string | false | | | -| `organization_ids` | array of string | false | | | -| `role` | [codersdk.TemplateRole](#codersdktemplaterole) | false | | | -| `roles` | array of [codersdk.SlimRole](#codersdkslimrole) | false | | | -| `status` | [codersdk.UserStatus](#codersdkuserstatus) | false | | | -| `theme_preference` | string | false | | Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead. | -| `updated_at` | string | false | | | -| `username` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`created_at`|string|true||| +|`email`|string|true||| +|`id`|string|true||| +|`last_seen_at`|string|false||| +|`login_type`|[codersdk.LoginType](#codersdklogintype)|false||| +|`name`|string|false||| +|`organization_ids`|array of string|false||| +|`role`|[codersdk.TemplateRole](#codersdktemplaterole)|false||| +|`roles`|array of [codersdk.SlimRole](#codersdkslimrole)|false||| +|`status`|[codersdk.UserStatus](#codersdkuserstatus)|false||| +|`theme_preference`|string|false||Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead.| +|`updated_at`|string|false||| +|`username`|string|true||| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `role` | `admin` | -| `role` | `use` | -| `status` | `active` | -| `status` | `suspended` | +|Property|Value| +|---|---| +|`role`|`admin`| +|`role`|`use`| +|`status`|`active`| +|`status`|`suspended`| ## codersdk.TemplateVersion @@ -7648,21 +7648,21 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|-----------------------------------------------------------------------------|----------|--------------|-------------| -| `archived` | boolean | false | | | -| `created_at` | string | false | | | -| `created_by` | [codersdk.MinimalUser](#codersdkminimaluser) | false | | | -| `id` | string | false | | | -| `job` | [codersdk.ProvisionerJob](#codersdkprovisionerjob) | false | | | -| `matched_provisioners` | [codersdk.MatchedProvisioners](#codersdkmatchedprovisioners) | false | | | -| `message` | string | false | | | -| `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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`archived`|boolean|false||| +|`created_at`|string|false||| +|`created_by`|[codersdk.MinimalUser](#codersdkminimaluser)|false||| +|`id`|string|false||| +|`job`|[codersdk.ProvisionerJob](#codersdkprovisionerjob)|false||| +|`matched_provisioners`|[codersdk.MatchedProvisioners](#codersdkmatchedprovisioners)|false||| +|`message`|string|false||| +|`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||| ## codersdk.TemplateVersionExternalAuth @@ -7680,15 +7680,15 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------|----------|--------------|-------------| -| `authenticate_url` | string | false | | | -| `authenticated` | boolean | false | | | -| `display_icon` | string | false | | | -| `display_name` | string | false | | | -| `id` | string | false | | | -| `optional` | boolean | false | | | -| `type` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`authenticate_url`|string|false||| +|`authenticated`|boolean|false||| +|`display_icon`|string|false||| +|`display_name`|string|false||| +|`id`|string|false||| +|`optional`|boolean|false||| +|`type`|string|false||| ## codersdk.TemplateVersionParameter @@ -7723,47 +7723,47 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------|---------------------------------------------------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------| -| `default_value` | string | false | | | -| `description` | string | false | | | -| `description_plaintext` | string | false | | | -| `display_name` | string | false | | | -| `ephemeral` | boolean | false | | | -| `form_type` | string | false | | Form type has an enum value of empty string, `""`. Keep the leading comma in the enums struct tag. | -| `icon` | string | false | | | -| `mutable` | boolean | false | | | -| `name` | string | false | | | -| `options` | array of [codersdk.TemplateVersionParameterOption](#codersdktemplateversionparameteroption) | false | | | -| `required` | boolean | false | | | -| `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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`default_value`|string|false||| +|`description`|string|false||| +|`description_plaintext`|string|false||| +|`display_name`|string|false||| +|`ephemeral`|boolean|false||| +|`form_type`|string|false||Form type has an enum value of empty string, `""`. Keep the leading comma in the enums struct tag.| +|`icon`|string|false||| +|`mutable`|boolean|false||| +|`name`|string|false||| +|`options`|array of [codersdk.TemplateVersionParameterOption](#codersdktemplateversionparameteroption)|false||| +|`required`|boolean|false||| +|`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||| #### Enumerated Values -| Property | Value | -|------------------------|----------------| -| `form_type` | `` | -| `form_type` | `radio` | -| `form_type` | `dropdown` | -| `form_type` | `input` | -| `form_type` | `textarea` | -| `form_type` | `slider` | -| `form_type` | `checkbox` | -| `form_type` | `switch` | -| `form_type` | `tag-select` | -| `form_type` | `multi-select` | -| `form_type` | `error` | -| `type` | `string` | -| `type` | `number` | -| `type` | `bool` | -| `type` | `list(string)` | -| `validation_monotonic` | `increasing` | -| `validation_monotonic` | `decreasing` | +|Property|Value| +|---|---| +|`form_type`|``| +|`form_type`|`radio`| +|`form_type`|`dropdown`| +|`form_type`|`input`| +|`form_type`|`textarea`| +|`form_type`|`slider`| +|`form_type`|`checkbox`| +|`form_type`|`switch`| +|`form_type`|`tag-select`| +|`form_type`|`multi-select`| +|`form_type`|`error`| +|`type`|`string`| +|`type`|`number`| +|`type`|`bool`| +|`type`|`list(string)`| +|`validation_monotonic`|`increasing`| +|`validation_monotonic`|`decreasing`| ## codersdk.TemplateVersionParameterOption @@ -7778,12 +7778,12 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|--------|----------|--------------|-------------| -| `description` | string | false | | | -| `icon` | string | false | | | -| `name` | string | false | | | -| `value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`description`|string|false||| +|`icon`|string|false||| +|`name`|string|false||| +|`value`|string|false||| ## codersdk.TemplateVersionVariable @@ -7801,23 +7801,23 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### 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 | | | +|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` | +|Property|Value| +|---|---| +|`type`|`string`| +|`type`|`number`| +|`type`|`bool`| ## codersdk.TemplateVersionWarning @@ -7829,9 +7829,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Value | -|--------------------------| -| `UNSUPPORTED_WORKSPACES` | +|Value| +|---| +|`UNSUPPORTED_WORKSPACES`| ## codersdk.TerminalFontName @@ -7843,13 +7843,13 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Value | -|-------------------| -| `` | -| `ibm-plex-mono` | -| `fira-code` | -| `source-code-pro` | -| `jetbrains-mono` | +|Value| +|---| +|``| +|`ibm-plex-mono`| +|`fira-code`| +|`source-code-pro`| +|`jetbrains-mono`| ## codersdk.TimingStage @@ -7861,16 +7861,16 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Value | -|-----------| -| `init` | -| `plan` | -| `graph` | -| `apply` | -| `start` | -| `stop` | -| `cron` | -| `connect` | +|Value| +|---| +|`init`| +|`plan`| +|`graph`| +|`apply`| +|`start`| +|`stop`| +|`cron`| +|`connect`| ## codersdk.TokenConfig @@ -7882,9 +7882,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|---------|----------|--------------|-------------| -| `max_token_lifetime` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`max_token_lifetime`|integer|false||| ## codersdk.TraceConfig @@ -7899,12 +7899,12 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|---------|----------|--------------|-------------| -| `capture_logs` | boolean | false | | | -| `data_dog` | boolean | false | | | -| `enable` | boolean | false | | | -| `honeycomb_api_key` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`capture_logs`|boolean|false||| +|`data_dog`|boolean|false||| +|`enable`|boolean|false||| +|`honeycomb_api_key`|string|false||| ## codersdk.TransitionStats @@ -7917,10 +7917,10 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|-------|---------|----------|--------------|-------------| -| `p50` | integer | false | | | -| `p95` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`p50`|integer|false||| +|`p95`|integer|false||| ## codersdk.UpdateActiveTemplateVersion @@ -7932,9 +7932,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|------|--------|----------|--------------|-------------| -| `id` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`id`|string|true||| ## codersdk.UpdateAppearanceConfig @@ -7959,12 +7959,12 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|---------------------------------------------------------|----------|--------------|---------------------------------------------------------------------| -| `announcement_banners` | array of [codersdk.BannerConfig](#codersdkbannerconfig) | false | | | -| `application_name` | string | false | | | -| `logo_url` | string | false | | | -| `service_banner` | [codersdk.BannerConfig](#codersdkbannerconfig) | false | | Deprecated: ServiceBanner has been replaced by AnnouncementBanners. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`announcement_banners`|array of [codersdk.BannerConfig](#codersdkbannerconfig)|false||| +|`application_name`|string|false||| +|`logo_url`|string|false||| +|`service_banner`|[codersdk.BannerConfig](#codersdkbannerconfig)|false||Deprecated: ServiceBanner has been replaced by AnnouncementBanners.| ## codersdk.UpdateCheckResponse @@ -7978,11 +7978,11 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### 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. | +|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.| ## codersdk.UpdateOrganizationRequest @@ -7997,12 +7997,12 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `description` | string | false | | | -| `display_name` | string | false | | | -| `icon` | string | false | | | -| `name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`description`|string|false||| +|`display_name`|string|false||| +|`icon`|string|false||| +|`name`|string|false||| ## codersdk.UpdateRoles @@ -8016,9 +8016,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|-----------------|----------|--------------|-------------| -| `roles` | array of string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`roles`|array of string|false||| ## codersdk.UpdateTemplateACL @@ -8037,12 +8037,12 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| 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 | | | +|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||| ## codersdk.UpdateUserAppearanceSettingsRequest @@ -8055,10 +8055,10 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|--------------------------------------------------------|----------|--------------|-------------| -| `terminal_font` | [codersdk.TerminalFontName](#codersdkterminalfontname) | true | | | -| `theme_preference` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`terminal_font`|[codersdk.TerminalFontName](#codersdkterminalfontname)|true||| +|`theme_preference`|string|true||| ## codersdk.UpdateUserNotificationPreferences @@ -8073,10 +8073,10 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------|---------|----------|--------------|-------------| -| `template_disabled_map` | object | false | | | -| » `[any property]` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`template_disabled_map`|object|false||| +|» `[any property]`|boolean|false||| ## codersdk.UpdateUserPasswordRequest @@ -8089,10 +8089,10 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `old_password` | string | false | | | -| `password` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`old_password`|string|false||| +|`password`|string|true||| ## codersdk.UpdateUserProfileRequest @@ -8105,10 +8105,10 @@ Restarts will only happen on weekdays in this list on weeks which line up with W ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|--------|----------|--------------|-------------| -| `name` | string | false | | | -| `username` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`name`|string|false||| +|`username`|string|true||| ## codersdk.UpdateUserQuietHoursScheduleRequest @@ -8136,9 +8136,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|--------------------------------------------------------|----------|--------------|-------------| -| `automatic_updates` | [codersdk.AutomaticUpdates](#codersdkautomaticupdates) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`automatic_updates`|[codersdk.AutomaticUpdates](#codersdkautomaticupdates)|false||| ## codersdk.UpdateWorkspaceAutostartRequest @@ -8150,9 +8150,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|--------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `schedule` | string | false | | Schedule is expected to be of the form `CRON_TZ= * * ` Example: `CRON_TZ=US/Central 30 9 * * 1-5` represents 0930 in the timezone US/Central on weekdays (Mon-Fri). `CRON_TZ` defaults to UTC if not present. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`schedule`|string|false||Schedule is expected to be of the form `CRON_TZ= * * ` Example: `CRON_TZ=US/Central 30 9 * * 1-5` represents 0930 in the timezone US/Central on weekdays (Mon-Fri). `CRON_TZ` defaults to UTC if not present.| ## codersdk.UpdateWorkspaceDormancy @@ -8164,9 +8164,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|---------|----------|--------------|-------------| -| `dormant` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`dormant`|boolean|false||| ## codersdk.UpdateWorkspaceRequest @@ -8178,9 +8178,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------|--------|----------|--------------|-------------| -| `name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`name`|string|false||| ## codersdk.UpdateWorkspaceTTLRequest @@ -8192,9 +8192,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|---------|----------|--------------|-------------| -| `ttl_ms` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`ttl_ms`|integer|false||| ## codersdk.UploadResponse @@ -8206,9 +8206,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------|--------|----------|--------------|-------------| -| `hash` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`hash`|string|false||| ## codersdk.UpsertWorkspaceAgentPortShareRequest @@ -8223,23 +8223,23 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|--------------------------------------------------------------------------------------|----------|--------------|-------------| -| `agent_name` | string | false | | | -| `port` | integer | false | | | -| `protocol` | [codersdk.WorkspaceAgentPortShareProtocol](#codersdkworkspaceagentportshareprotocol) | false | | | -| `share_level` | [codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`agent_name`|string|false||| +|`port`|integer|false||| +|`protocol`|[codersdk.WorkspaceAgentPortShareProtocol](#codersdkworkspaceagentportshareprotocol)|false||| +|`share_level`|[codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel)|false||| #### Enumerated Values -| Property | Value | -|---------------|-----------------| -| `protocol` | `http` | -| `protocol` | `https` | -| `share_level` | `owner` | -| `share_level` | `authenticated` | -| `share_level` | `organization` | -| `share_level` | `public` | +|Property|Value| +|---|---| +|`protocol`|`http`| +|`protocol`|`https`| +|`share_level`|`owner`| +|`share_level`|`authenticated`| +|`share_level`|`organization`| +|`share_level`|`public`| ## codersdk.UsageAppName @@ -8251,12 +8251,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|--------------------| -| `vscode` | -| `jetbrains` | -| `reconnecting-pty` | -| `ssh` | +|Value| +|---| +|`vscode`| +|`jetbrains`| +|`reconnecting-pty`| +|`ssh`| ## codersdk.UsagePeriod @@ -8270,11 +8270,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|--------|----------|--------------|-------------| -| `end` | string | false | | | -| `issued_at` | string | false | | | -| `start` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`end`|string|false||| +|`issued_at`|string|false||| +|`start`|string|false||| ## codersdk.User @@ -8306,28 +8306,28 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### 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 | | | -| `login_type` | [codersdk.LoginType](#codersdklogintype) | false | | | -| `name` | string | false | | | -| `organization_ids` | array of string | false | | | -| `roles` | array of [codersdk.SlimRole](#codersdkslimrole) | false | | | -| `status` | [codersdk.UserStatus](#codersdkuserstatus) | false | | | -| `theme_preference` | string | false | | Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead. | -| `updated_at` | string | false | | | -| `username` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`created_at`|string|true||| +|`email`|string|true||| +|`id`|string|true||| +|`last_seen_at`|string|false||| +|`login_type`|[codersdk.LoginType](#codersdklogintype)|false||| +|`name`|string|false||| +|`organization_ids`|array of string|false||| +|`roles`|array of [codersdk.SlimRole](#codersdkslimrole)|false||| +|`status`|[codersdk.UserStatus](#codersdkuserstatus)|false||| +|`theme_preference`|string|false||Deprecated: this value should be retrieved from `codersdk.UserPreferenceSettings` instead.| +|`updated_at`|string|false||| +|`username`|string|true||| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `active` | -| `status` | `suspended` | +|Property|Value| +|---|---| +|`status`|`active`| +|`status`|`suspended`| ## codersdk.UserActivity @@ -8345,13 +8345,13 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### 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 | | | +|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 @@ -8378,12 +8378,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### 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 | | | +|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 @@ -8412,9 +8412,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|----------------------------------------------------------------------------|----------|--------------|-------------| -| `report` | [codersdk.UserActivityInsightsReport](#codersdkuseractivityinsightsreport) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`report`|[codersdk.UserActivityInsightsReport](#codersdkuseractivityinsightsreport)|false||| ## codersdk.UserAppearanceSettings @@ -8427,10 +8427,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|--------------------------------------------------------|----------|--------------|-------------| -| `terminal_font` | [codersdk.TerminalFontName](#codersdkterminalfontname) | false | | | -| `theme_preference` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`terminal_font`|[codersdk.TerminalFontName](#codersdkterminalfontname)|false||| +|`theme_preference`|string|false||| ## codersdk.UserLatency @@ -8451,13 +8451,13 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|----------------------------------------------------------|----------|--------------|-------------| -| `avatar_url` | string | false | | | -| `latency_ms` | [codersdk.ConnectionLatency](#codersdkconnectionlatency) | false | | | -| `template_ids` | array of string | false | | | -| `user_id` | string | false | | | -| `username` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`avatar_url`|string|false||| +|`latency_ms`|[codersdk.ConnectionLatency](#codersdkconnectionlatency)|false||| +|`template_ids`|array of string|false||| +|`user_id`|string|false||| +|`username`|string|false||| ## codersdk.UserLatencyInsightsReport @@ -8487,12 +8487,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### 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 | | | +|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 @@ -8524,9 +8524,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|--------------------------------------------------------------------------|----------|--------------|-------------| -| `report` | [codersdk.UserLatencyInsightsReport](#codersdkuserlatencyinsightsreport) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`report`|[codersdk.UserLatencyInsightsReport](#codersdkuserlatencyinsightsreport)|false||| ## codersdk.UserLoginType @@ -8538,9 +8538,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|------------------------------------------|----------|--------------|-------------| -| `login_type` | [codersdk.LoginType](#codersdklogintype) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`login_type`|[codersdk.LoginType](#codersdklogintype)|false||| ## codersdk.UserParameter @@ -8553,10 +8553,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|--------|----------|--------------|-------------| -| `name` | string | false | | | -| `value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`name`|string|false||| +|`value`|string|false||| ## codersdk.UserQuietHoursScheduleConfig @@ -8569,10 +8569,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|---------|----------|--------------|-------------| -| `allow_user_custom` | boolean | false | | | -| `default_schedule` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`allow_user_custom`|boolean|false||| +|`default_schedule`|string|false||| ## codersdk.UserQuietHoursScheduleResponse @@ -8589,14 +8589,14 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| 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. | +|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.| ## codersdk.UserStatus @@ -8608,11 +8608,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|-------------| -| `active` | -| `dormant` | -| `suspended` | +|Value| +|---| +|`active`| +|`dormant`| +|`suspended`| ## codersdk.UserStatusChangeCount @@ -8625,10 +8625,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|---------|----------|--------------|-------------| -| `count` | integer | false | | | -| `date` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`count`|integer|false||| +|`date`|string|false||| ## codersdk.ValidateUserPasswordRequest @@ -8640,9 +8640,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------|--------|----------|--------------|-------------| -| `password` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`password`|string|true||| ## codersdk.ValidateUserPasswordResponse @@ -8655,10 +8655,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|---------|----------|--------------|-------------| -| `details` | string | false | | | -| `valid` | boolean | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`details`|string|false||| +|`valid`|boolean|false||| ## codersdk.ValidationError @@ -8671,10 +8671,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|--------|----------|--------------|-------------| -| `detail` | string | true | | | -| `field` | string | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`detail`|string|true||| +|`field`|string|true||| ## codersdk.ValidationMonotonicOrder @@ -8686,10 +8686,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|--------------| -| `increasing` | -| `decreasing` | +|Value| +|---| +|`increasing`| +|`decreasing`| ## codersdk.VariableValue @@ -8702,10 +8702,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|--------|----------|--------------|-------------| -| `name` | string | false | | | -| `value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`name`|string|false||| +|`value`|string|false||| ## codersdk.WebpushSubscription @@ -8719,11 +8719,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|--------|----------|--------------|-------------| -| `auth_key` | string | false | | | -| `endpoint` | string | false | | | -| `p256dh_key` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`auth_key`|string|false||| +|`endpoint`|string|false||| +|`p256dh_key`|string|false||| ## codersdk.Workspace @@ -8983,46 +8983,46 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------------------------------|------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `allow_renames` | boolean | false | | | -| `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. | -| `favorite` | boolean | false | | | -| `health` | [codersdk.WorkspaceHealth](#codersdkworkspacehealth) | false | | Health shows the health of the workspace and information about what is causing an unhealthy status. | -| `id` | string | false | | | -| `is_prebuild` | boolean | false | | Is prebuild indicates whether the workspace is a prebuilt workspace. Prebuilt workspaces are owned by the prebuilds system user and have specific behavior, such as being managed differently from regular workspaces. Once a prebuilt workspace is claimed by a user, it transitions to a regular workspace, and IsPrebuild returns false. | -| `last_used_at` | string | false | | | -| `latest_app_status` | [codersdk.WorkspaceAppStatus](#codersdkworkspaceappstatus) | false | | | -| `latest_build` | [codersdk.WorkspaceBuild](#codersdkworkspacebuild) | false | | | -| `name` | string | false | | | -| `next_start_at` | string | false | | | -| `organization_id` | string | false | | | -| `organization_name` | string | false | | | -| `outdated` | boolean | false | | | -| `owner_avatar_url` | string | false | | | -| `owner_id` | string | false | | | -| `owner_name` | string | false | | Owner name is the username of the owner of the workspace. | -| `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 | | | -| `template_require_active_version` | boolean | false | | | -| `template_use_classic_parameter_flow` | boolean | false | | | -| `ttl_ms` | integer | false | | | -| `updated_at` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`allow_renames`|boolean|false||| +|`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.| +|`favorite`|boolean|false||| +|`health`|[codersdk.WorkspaceHealth](#codersdkworkspacehealth)|false||Health shows the health of the workspace and information about what is causing an unhealthy status.| +|`id`|string|false||| +|`is_prebuild`|boolean|false||Is prebuild indicates whether the workspace is a prebuilt workspace. Prebuilt workspaces are owned by the prebuilds system user and have specific behavior, such as being managed differently from regular workspaces. Once a prebuilt workspace is claimed by a user, it transitions to a regular workspace, and IsPrebuild returns false.| +|`last_used_at`|string|false||| +|`latest_app_status`|[codersdk.WorkspaceAppStatus](#codersdkworkspaceappstatus)|false||| +|`latest_build`|[codersdk.WorkspaceBuild](#codersdkworkspacebuild)|false||| +|`name`|string|false||| +|`next_start_at`|string|false||| +|`organization_id`|string|false||| +|`organization_name`|string|false||| +|`outdated`|boolean|false||| +|`owner_avatar_url`|string|false||| +|`owner_id`|string|false||| +|`owner_name`|string|false||Owner name is the username of the owner of the workspace.| +|`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||| +|`template_require_active_version`|boolean|false||| +|`template_use_classic_parameter_flow`|boolean|false||| +|`ttl_ms`|integer|false||| +|`updated_at`|string|false||| #### Enumerated Values -| Property | Value | -|---------------------|----------| -| `automatic_updates` | `always` | -| `automatic_updates` | `never` | +|Property|Value| +|---|---| +|`automatic_updates`|`always`| +|`automatic_updates`|`never`| ## codersdk.WorkspaceAgent @@ -9145,43 +9145,43 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|----------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `api_version` | string | false | | | -| `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 | | | -| `parent_id` | [uuid.NullUUID](#uuidnulluuid) | 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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`api_version`|string|false||| +|`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||| +|`parent_id`|[uuid.NullUUID](#uuidnulluuid)|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||| ## codersdk.WorkspaceAgentContainer @@ -9214,19 +9214,19 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------------------------------------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------| -| `created_at` | string | false | | Created at is the time the container was created. | -| `id` | string | false | | ID is the unique identifier of the container. | -| `image` | string | false | | Image is the name of the container image. | -| `labels` | object | false | | Labels is a map of key-value pairs of container labels. | -| » `[any property]` | string | false | | | -| `name` | string | false | | Name is the human-readable name of the container. | -| `ports` | array of [codersdk.WorkspaceAgentContainerPort](#codersdkworkspaceagentcontainerport) | false | | Ports includes ports exposed by the container. | -| `running` | boolean | false | | Running is true if the container is currently running. | -| `status` | string | false | | Status is the current status of the container. This is somewhat implementation-dependent, but should generally be a human-readable string. | -| `volumes` | object | false | | Volumes is a map of "things" mounted into the container. Again, this is somewhat implementation-dependent. | -| » `[any property]` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|false||Created at is the time the container was created.| +|`id`|string|false||ID is the unique identifier of the container.| +|`image`|string|false||Image is the name of the container image.| +|`labels`|object|false||Labels is a map of key-value pairs of container labels.| +|» `[any property]`|string|false||| +|`name`|string|false||Name is the human-readable name of the container.| +|`ports`|array of [codersdk.WorkspaceAgentContainerPort](#codersdkworkspaceagentcontainerport)|false||Ports includes ports exposed by the container.| +|`running`|boolean|false||Running is true if the container is currently running.| +|`status`|string|false||Status is the current status of the container. This is somewhat implementation-dependent, but should generally be a human-readable string.| +|`volumes`|object|false||Volumes is a map of "things" mounted into the container. Again, this is somewhat implementation-dependent.| +|» `[any property]`|string|false||| ## codersdk.WorkspaceAgentContainerPort @@ -9241,12 +9241,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|---------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------| -| `host_ip` | string | false | | Host ip is the IP address of the host interface to which the port is bound. Note that this can be an IPv4 or IPv6 address. | -| `host_port` | integer | false | | Host port is the port number *outside* the container. | -| `network` | string | false | | Network is the network protocol used by the port (tcp, udp, etc). | -| `port` | integer | false | | Port is the port number *inside* the container. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`host_ip`|string|false||Host ip is the IP address of the host interface to which the port is bound. Note that this can be an IPv4 or IPv6 address.| +|`host_port`|integer|false||Host port is the port number *outside* the container.| +|`network`|string|false||Network is the network protocol used by the port (tcp, udp, etc).| +|`port`|integer|false||Port is the port number *inside* the container.| ## codersdk.WorkspaceAgentDevcontainer @@ -9293,17 +9293,17 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|----------------------------------------------------------------------------------------|----------|--------------|----------------------------| -| `agent` | [codersdk.WorkspaceAgentDevcontainerAgent](#codersdkworkspaceagentdevcontaineragent) | false | | | -| `config_path` | string | false | | | -| `container` | [codersdk.WorkspaceAgentContainer](#codersdkworkspaceagentcontainer) | false | | | -| `dirty` | boolean | false | | | -| `error` | string | false | | | -| `id` | string | false | | | -| `name` | string | false | | | -| `status` | [codersdk.WorkspaceAgentDevcontainerStatus](#codersdkworkspaceagentdevcontainerstatus) | false | | Additional runtime fields. | -| `workspace_folder` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`agent`|[codersdk.WorkspaceAgentDevcontainerAgent](#codersdkworkspaceagentdevcontaineragent)|false||| +|`config_path`|string|false||| +|`container`|[codersdk.WorkspaceAgentContainer](#codersdkworkspaceagentcontainer)|false||| +|`dirty`|boolean|false||| +|`error`|string|false||| +|`id`|string|false||| +|`name`|string|false||| +|`status`|[codersdk.WorkspaceAgentDevcontainerStatus](#codersdkworkspaceagentdevcontainerstatus)|false||Additional runtime fields.| +|`workspace_folder`|string|false||| ## codersdk.WorkspaceAgentDevcontainerAgent @@ -9317,11 +9317,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|--------|----------|--------------|-------------| -| `directory` | string | false | | | -| `id` | string | false | | | -| `name` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`directory`|string|false||| +|`id`|string|false||| +|`name`|string|false||| ## codersdk.WorkspaceAgentDevcontainerStatus @@ -9333,12 +9333,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|------------| -| `running` | -| `stopped` | -| `starting` | -| `error` | +|Value| +|---| +|`running`| +|`stopped`| +|`starting`| +|`error`| ## codersdk.WorkspaceAgentHealth @@ -9351,10 +9351,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### 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. | +|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.| ## codersdk.WorkspaceAgentLifecycle @@ -9366,17 +9366,17 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|--------------------| -| `created` | -| `starting` | -| `start_timeout` | -| `start_error` | -| `ready` | -| `shutting_down` | -| `shutdown_timeout` | -| `shutdown_error` | -| `off` | +|Value| +|---| +|`created`| +|`starting`| +|`start_timeout`| +|`start_error`| +|`ready`| +|`shutting_down`| +|`shutdown_timeout`| +|`shutdown_error`| +|`off`| ## codersdk.WorkspaceAgentListContainersResponse @@ -9456,11 +9456,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------|-------------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------| -| `containers` | array of [codersdk.WorkspaceAgentContainer](#codersdkworkspaceagentcontainer) | false | | Containers is a list of containers visible to the workspace agent. | -| `devcontainers` | array of [codersdk.WorkspaceAgentDevcontainer](#codersdkworkspaceagentdevcontainer) | false | | Devcontainers is a list of devcontainers visible to the workspace agent. | -| `warnings` | array of string | false | | Warnings is a list of warnings that may have occurred during the process of listing containers. This should not include fatal errors. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`containers`|array of [codersdk.WorkspaceAgentContainer](#codersdkworkspaceagentcontainer)|false||Containers is a list of containers visible to the workspace agent.| +|`devcontainers`|array of [codersdk.WorkspaceAgentDevcontainer](#codersdkworkspaceagentdevcontainer)|false||Devcontainers is a list of devcontainers visible to the workspace agent.| +|`warnings`|array of string|false||Warnings is a list of warnings that may have occurred during the process of listing containers. This should not include fatal errors.| ## codersdk.WorkspaceAgentListeningPort @@ -9474,11 +9474,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|---------|----------|--------------|--------------------------| -| `network` | string | false | | only "tcp" at the moment | -| `port` | integer | false | | | -| `process_name` | string | false | | may be empty | +|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 @@ -9496,9 +9496,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| 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. | +|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.| ## codersdk.WorkspaceAgentLog @@ -9514,13 +9514,13 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|----------------------------------------|----------|--------------|-------------| -| `created_at` | string | false | | | -| `id` | integer | false | | | -| `level` | [codersdk.LogLevel](#codersdkloglevel) | false | | | -| `output` | string | false | | | -| `source_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|false||| +|`id`|integer|false||| +|`level`|[codersdk.LogLevel](#codersdkloglevel)|false||| +|`output`|string|false||| +|`source_id`|string|false||| ## codersdk.WorkspaceAgentLogSource @@ -9536,13 +9536,13 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|--------|----------|--------------|-------------| -| `created_at` | string | false | | | -| `display_name` | string | false | | | -| `icon` | string | false | | | -| `id` | string | false | | | -| `workspace_agent_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|false||| +|`display_name`|string|false||| +|`icon`|string|false||| +|`id`|string|false||| +|`workspace_agent_id`|string|false||| ## codersdk.WorkspaceAgentPortShare @@ -9558,24 +9558,24 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|--------------------------------------------------------------------------------------|----------|--------------|-------------| -| `agent_name` | string | false | | | -| `port` | integer | false | | | -| `protocol` | [codersdk.WorkspaceAgentPortShareProtocol](#codersdkworkspaceagentportshareprotocol) | false | | | -| `share_level` | [codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel) | false | | | -| `workspace_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`agent_name`|string|false||| +|`port`|integer|false||| +|`protocol`|[codersdk.WorkspaceAgentPortShareProtocol](#codersdkworkspaceagentportshareprotocol)|false||| +|`share_level`|[codersdk.WorkspaceAgentPortShareLevel](#codersdkworkspaceagentportsharelevel)|false||| +|`workspace_id`|string|false||| #### Enumerated Values -| Property | Value | -|---------------|-----------------| -| `protocol` | `http` | -| `protocol` | `https` | -| `share_level` | `owner` | -| `share_level` | `authenticated` | -| `share_level` | `organization` | -| `share_level` | `public` | +|Property|Value| +|---|---| +|`protocol`|`http`| +|`protocol`|`https`| +|`share_level`|`owner`| +|`share_level`|`authenticated`| +|`share_level`|`organization`| +|`share_level`|`public`| ## codersdk.WorkspaceAgentPortShareLevel @@ -9587,12 +9587,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|-----------------| -| `owner` | -| `authenticated` | -| `organization` | -| `public` | +|Value| +|---| +|`owner`| +|`authenticated`| +|`organization`| +|`public`| ## codersdk.WorkspaceAgentPortShareProtocol @@ -9604,10 +9604,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|---------| -| `http` | -| `https` | +|Value| +|---| +|`http`| +|`https`| ## codersdk.WorkspaceAgentPortShares @@ -9627,9 +9627,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------|-------------------------------------------------------------------------------|----------|--------------|-------------| -| `shares` | array of [codersdk.WorkspaceAgentPortShare](#codersdkworkspaceagentportshare) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`shares`|array of [codersdk.WorkspaceAgentPortShare](#codersdkworkspaceagentportshare)|false||| ## codersdk.WorkspaceAgentScript @@ -9650,18 +9650,18 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|---------|----------|--------------|-------------| -| `cron` | string | false | | | -| `display_name` | string | false | | | -| `id` | 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 | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`cron`|string|false||| +|`display_name`|string|false||| +|`id`|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||| ## codersdk.WorkspaceAgentStartupScriptBehavior @@ -9673,10 +9673,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|----------------| -| `blocking` | -| `non-blocking` | +|Value| +|---| +|`blocking`| +|`non-blocking`| ## codersdk.WorkspaceAgentStatus @@ -9688,12 +9688,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|----------------| -| `connecting` | -| `connected` | -| `disconnected` | -| `timeout` | +|Value| +|---| +|`connecting`| +|`connected`| +|`disconnected`| +|`timeout`| ## codersdk.WorkspaceApp @@ -9737,33 +9737,33 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| 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. | -| `group` | string | false | | | -| `health` | [codersdk.WorkspaceAppHealth](#codersdkworkspaceapphealth) | false | | | -| `healthcheck` | [codersdk.Healthcheck](#codersdkhealthcheck) | false | | Healthcheck specifies the configuration for checking app health. | -| `hidden` | boolean | false | | | -| `icon` | string | false | | Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. | -| `id` | string | false | | | -| `open_in` | [codersdk.WorkspaceAppOpenIn](#codersdkworkspaceappopenin) | false | | | -| `sharing_level` | [codersdk.WorkspaceAppSharingLevel](#codersdkworkspaceappsharinglevel) | false | | | -| `slug` | string | false | | Slug is a unique identifier within the agent. | -| `statuses` | array of [codersdk.WorkspaceAppStatus](#codersdkworkspaceappstatus) | false | | Statuses is a list of statuses for the app. | -| `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. | +|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.| +|`group`|string|false||| +|`health`|[codersdk.WorkspaceAppHealth](#codersdkworkspaceapphealth)|false||| +|`healthcheck`|[codersdk.Healthcheck](#codersdkhealthcheck)|false||Healthcheck specifies the configuration for checking app health.| +|`hidden`|boolean|false||| +|`icon`|string|false||Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.| +|`id`|string|false||| +|`open_in`|[codersdk.WorkspaceAppOpenIn](#codersdkworkspaceappopenin)|false||| +|`sharing_level`|[codersdk.WorkspaceAppSharingLevel](#codersdkworkspaceappsharinglevel)|false||| +|`slug`|string|false||Slug is a unique identifier within the agent.| +|`statuses`|array of [codersdk.WorkspaceAppStatus](#codersdkworkspaceappstatus)|false||Statuses is a list of statuses for the app.| +|`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.| #### Enumerated Values -| Property | Value | -|-----------------|-----------------| -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | +|Property|Value| +|---|---| +|`sharing_level`|`owner`| +|`sharing_level`|`authenticated`| +|`sharing_level`|`organization`| +|`sharing_level`|`public`| ## codersdk.WorkspaceAppHealth @@ -9775,12 +9775,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|----------------| -| `disabled` | -| `initializing` | -| `healthy` | -| `unhealthy` | +|Value| +|---| +|`disabled`| +|`initializing`| +|`healthy`| +|`unhealthy`| ## codersdk.WorkspaceAppOpenIn @@ -9792,10 +9792,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|---------------| -| `slim-window` | -| `tab` | +|Value| +|---| +|`slim-window`| +|`tab`| ## codersdk.WorkspaceAppSharingLevel @@ -9807,12 +9807,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|-----------------| -| `owner` | -| `authenticated` | -| `organization` | -| `public` | +|Value| +|---| +|`owner`| +|`authenticated`| +|`organization`| +|`public`| ## codersdk.WorkspaceAppStatus @@ -9833,18 +9833,18 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|----------------------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------| -| `agent_id` | string | false | | | -| `app_id` | string | false | | | -| `created_at` | string | false | | | -| `icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. | -| `id` | string | false | | | -| `message` | string | false | | | -| `needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. | -| `state` | [codersdk.WorkspaceAppStatusState](#codersdkworkspaceappstatusstate) | false | | | -| `uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file | -| `workspace_id` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`agent_id`|string|false||| +|`app_id`|string|false||| +|`created_at`|string|false||| +|`icon`|string|false||Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI.| +|`id`|string|false||| +|`message`|string|false||| +|`needs_user_attention`|boolean|false||Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention.| +|`state`|[codersdk.WorkspaceAppStatusState](#codersdkworkspaceappstatusstate)|false||| +|`uri`|string|false||Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file| +|`workspace_id`|string|false||| ## codersdk.WorkspaceAppStatusState @@ -9856,12 +9856,12 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|------------| -| `working` | -| `idle` | -| `complete` | -| `failure` | +|Value| +|---| +|`working`| +|`idle`| +|`complete`| +|`failure`| ## codersdk.WorkspaceBuild @@ -10073,54 +10073,54 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|-------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------| -| `ai_task_sidebar_app_id` | string | false | | | -| `build_number` | integer | false | | | -| `created_at` | string | false | | | -| `daily_cost` | integer | false | | | -| `deadline` | string | false | | | -| `has_ai_task` | boolean | false | | | -| `id` | string | false | | | -| `initiator_id` | string | false | | | -| `initiator_name` | string | false | | | -| `job` | [codersdk.ProvisionerJob](#codersdkprovisionerjob) | false | | | -| `matched_provisioners` | [codersdk.MatchedProvisioners](#codersdkmatchedprovisioners) | 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 | | | -| `template_version_preset_id` | 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 | | Workspace owner name is the username of the owner of the workspace. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`ai_task_sidebar_app_id`|string|false||| +|`build_number`|integer|false||| +|`created_at`|string|false||| +|`daily_cost`|integer|false||| +|`deadline`|string|false||| +|`has_ai_task`|boolean|false||| +|`id`|string|false||| +|`initiator_id`|string|false||| +|`initiator_name`|string|false||| +|`job`|[codersdk.ProvisionerJob](#codersdkprovisionerjob)|false||| +|`matched_provisioners`|[codersdk.MatchedProvisioners](#codersdkmatchedprovisioners)|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||| +|`template_version_preset_id`|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||Workspace owner name is the username of the owner of the workspace.| #### Enumerated Values -| Property | Value | -|--------------|-------------| -| `reason` | `initiator` | -| `reason` | `autostart` | -| `reason` | `autostop` | -| `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` | +|Property|Value| +|---|---| +|`reason`|`initiator`| +|`reason`|`autostart`| +|`reason`|`autostop`| +|`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`| ## codersdk.WorkspaceBuildParameter @@ -10133,10 +10133,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|--------|----------|--------------|-------------| -| `name` | string | false | | | -| `value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`name`|string|false||| +|`value`|string|false||| ## codersdk.WorkspaceBuildTimings @@ -10179,11 +10179,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------------|---------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------| -| `agent_connection_timings` | array of [codersdk.AgentConnectionTiming](#codersdkagentconnectiontiming) | false | | | -| `agent_script_timings` | array of [codersdk.AgentScriptTiming](#codersdkagentscripttiming) | false | | Agent script timings Consolidate agent-related timing metrics into a single struct when updating the API version | -| `provisioner_timings` | array of [codersdk.ProvisionerTiming](#codersdkprovisionertiming) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`agent_connection_timings`|array of [codersdk.AgentConnectionTiming](#codersdkagentconnectiontiming)|false||| +|`agent_script_timings`|array of [codersdk.AgentScriptTiming](#codersdkagentscripttiming)|false||Agent script timings Consolidate agent-related timing metrics into a single struct when updating the API version| +|`provisioner_timings`|array of [codersdk.ProvisionerTiming](#codersdkprovisionertiming)|false||| ## codersdk.WorkspaceConnectionLatencyMS @@ -10196,10 +10196,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------|--------|----------|--------------|-------------| -| `p50` | number | false | | | -| `p95` | number | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`p50`|number|false||| +|`p95`|number|false||| ## codersdk.WorkspaceDeploymentStats @@ -10221,16 +10221,16 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### 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 | | | +|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||| ## codersdk.WorkspaceHealth @@ -10245,10 +10245,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### 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. | +|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.| ## codersdk.WorkspaceProxy @@ -10284,22 +10284,22 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------------|----------------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `created_at` | string | false | | | -| `deleted` | boolean | false | | | -| `derp_enabled` | boolean | false | | | -| `derp_only` | boolean | false | | | -| `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 | | | -| `version` | string | false | | | -| `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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`created_at`|string|false||| +|`deleted`|boolean|false||| +|`derp_enabled`|boolean|false||| +|`derp_only`|boolean|false||| +|`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||| +|`version`|string|false||| +|`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.| ## codersdk.WorkspaceProxyStatus @@ -10320,11 +10320,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### 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 | | | +|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||| ## codersdk.WorkspaceQuota @@ -10337,10 +10337,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|---------|----------|--------------|-------------| -| `budget` | integer | false | | | -| `credits_consumed` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`budget`|integer|false||| +|`credits_consumed`|integer|false||| ## codersdk.WorkspaceResource @@ -10483,27 +10483,27 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------|-----------------------------------------------------------------------------------|----------|--------------|-------------| -| `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 | | | -| `workspace_transition` | [codersdk.WorkspaceTransition](#codersdkworkspacetransition) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`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||| +|`workspace_transition`|[codersdk.WorkspaceTransition](#codersdkworkspacetransition)|false||| #### Enumerated Values -| Property | Value | -|------------------------|----------| -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | +|Property|Value| +|---|---| +|`workspace_transition`|`start`| +|`workspace_transition`|`stop`| +|`workspace_transition`|`delete`| ## codersdk.WorkspaceResourceMetadata @@ -10517,11 +10517,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|---------|----------|--------------|-------------| -| `key` | string | false | | | -| `sensitive` | boolean | false | | | -| `value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`key`|string|false||| +|`sensitive`|boolean|false||| +|`value`|string|false||| ## codersdk.WorkspaceStatus @@ -10533,18 +10533,18 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|-------------| -| `pending` | -| `starting` | -| `running` | -| `stopping` | -| `stopped` | -| `failed` | -| `canceling` | -| `canceled` | -| `deleting` | -| `deleted` | +|Value| +|---| +|`pending`| +|`starting`| +|`running`| +|`stopping`| +|`stopped`| +|`failed`| +|`canceling`| +|`canceled`| +|`deleting`| +|`deleted`| ## codersdk.WorkspaceTransition @@ -10556,11 +10556,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|----------| -| `start` | -| `stop` | -| `delete` | +|Value| +|---| +|`start`| +|`stop`| +|`delete`| ## codersdk.WorkspacesResponse @@ -10808,10 +10808,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------|---------------------------------------------------|----------|--------------|-------------| -| `count` | integer | false | | | -| `workspaces` | array of [codersdk.Workspace](#codersdkworkspace) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`count`|integer|false||| +|`workspaces`|array of [codersdk.Workspace](#codersdkworkspace)|false||| ## derp.BytesSentRecv @@ -10825,11 +10825,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| ### Properties -| Name | Type | Required | Restrictions | Description | -|--------|----------------------------------|----------|--------------|----------------------------------------------------------------------| -| `key` | [key.NodePublic](#keynodepublic) | false | | Key is the public key of the client which sent/received these bytes. | -| `recv` | integer | false | | | -| `sent` | integer | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`key`|[key.NodePublic](#keynodepublic)|false||Key is the public key of the client which sent/received these bytes.| +|`recv`|integer|false||| +|`sent`|integer|false||| ## derp.ServerInfoMessage @@ -10859,26 +10859,26 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Value | -|------------| -| `EUNKNOWN` | -| `EWP01` | -| `EWP02` | -| `EWP04` | -| `EDB01` | -| `EDB02` | -| `EWS01` | -| `EWS02` | -| `EWS03` | -| `EACS01` | -| `EACS02` | -| `EACS03` | -| `EACS04` | -| `EDERP01` | -| `EDERP02` | -| `EPD01` | -| `EPD02` | -| `EPD03` | +|Value| +|---| +|`EUNKNOWN`| +|`EWP01`| +|`EWP02`| +|`EWP04`| +|`EDB01`| +|`EDB02`| +|`EWS01`| +|`EWS02`| +|`EWS03`| +|`EACS01`| +|`EACS02`| +|`EACS03`| +|`EACS04`| +|`EDERP01`| +|`EDERP02`| +|`EPD01`| +|`EPD02`| +|`EPD03`| ## health.Message @@ -10891,10 +10891,10 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|----------------------------|----------|--------------|-------------| -| `code` | [health.Code](#healthcode) | false | | | -| `message` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`code`|[health.Code](#healthcode)|false||| +|`message`|string|false||| ## health.Severity @@ -10906,11 +10906,11 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Value | -|-----------| -| `ok` | -| `warning` | -| `error` | +|Value| +|---| +|`ok`| +|`warning`| +|`error`| ## healthsdk.AccessURLReport @@ -10935,25 +10935,25 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| 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 | | | +|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||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## healthsdk.DERPHealthReport @@ -11182,26 +11182,26 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| 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. | -| `netcheck` | [netcheck.Report](#netcheckreport) | false | | | -| `netcheck_err` | string | false | | | -| `netcheck_logs` | array of string | false | | | -| `regions` | object | false | | | -| » `[any property]` | [healthsdk.DERPRegionReport](#healthsdkderpregionreport) | false | | | -| `severity` | [health.Severity](#healthseverity) | false | | | -| `warnings` | array of [health.Message](#healthmessage) | false | | | +|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.| +|`netcheck`|[netcheck.Report](#netcheckreport)|false||| +|`netcheck_err`|string|false||| +|`netcheck_logs`|array of string|false||| +|`regions`|object|false||| +|» `[any property]`|[healthsdk.DERPRegionReport](#healthsdkderpregionreport)|false||| +|`severity`|[health.Severity](#healthseverity)|false||| +|`warnings`|array of [health.Message](#healthmessage)|false||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## healthsdk.DERPNodeReport @@ -11259,29 +11259,29 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| 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` | [healthsdk.STUNReport](#healthsdkstunreport) | false | | | -| `uses_websocket` | boolean | false | | | -| `warnings` | array of [health.Message](#healthmessage) | false | | | +|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`|[healthsdk.STUNReport](#healthsdkstunreport)|false||| +|`uses_websocket`|boolean|false||| +|`warnings`|array of [health.Message](#healthmessage)|false||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## healthsdk.DERPRegionReport @@ -11376,22 +11376,22 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| 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 [healthsdk.DERPNodeReport](#healthsdkderpnodereport) | false | | | -| `region` | [tailcfg.DERPRegion](#tailcfgderpregion) | false | | | -| `severity` | [health.Severity](#healthseverity) | false | | | -| `warnings` | array of [health.Message](#healthmessage) | false | | | +|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 [healthsdk.DERPNodeReport](#healthsdkderpnodereport)|false||| +|`region`|[tailcfg.DERPRegion](#tailcfgderpregion)|false||| +|`severity`|[health.Severity](#healthseverity)|false||| +|`warnings`|array of [health.Message](#healthmessage)|false||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## healthsdk.DatabaseReport @@ -11416,25 +11416,25 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| 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 | | | +|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||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## healthsdk.HealthSection @@ -11446,14 +11446,14 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Value | -|----------------------| -| `DERP` | -| `AccessURL` | -| `Websocket` | -| `Database` | -| `WorkspaceProxy` | -| `ProvisionerDaemons` | +|Value| +|---| +|`DERP`| +|`AccessURL`| +|`Websocket`| +|`Database`| +|`WorkspaceProxy`| +|`ProvisionerDaemons`| ## healthsdk.HealthSettings @@ -11467,9 +11467,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------------|-------------------------------------------------------------|----------|--------------|-------------| -| `dismissed_healthchecks` | array of [healthsdk.HealthSection](#healthsdkhealthsection) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`dismissed_healthchecks`|array of [healthsdk.HealthSection](#healthsdkhealthsection)|false||| ## healthsdk.HealthcheckReport @@ -11847,26 +11847,26 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------------------|--------------------------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------| -| `access_url` | [healthsdk.AccessURLReport](#healthsdkaccessurlreport) | false | | | -| `coder_version` | string | false | | The Coder version of the server that the report was generated on. | -| `database` | [healthsdk.DatabaseReport](#healthsdkdatabasereport) | false | | | -| `derp` | [healthsdk.DERPHealthReport](#healthsdkderphealthreport) | false | | | -| `healthy` | boolean | false | | Healthy is true if the report returns no errors. Deprecated: use `Severity` instead | -| `provisioner_daemons` | [healthsdk.ProvisionerDaemonsReport](#healthsdkprovisionerdaemonsreport) | 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` | [healthsdk.WebsocketReport](#healthsdkwebsocketreport) | false | | | -| `workspace_proxy` | [healthsdk.WorkspaceProxyReport](#healthsdkworkspaceproxyreport) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`access_url`|[healthsdk.AccessURLReport](#healthsdkaccessurlreport)|false||| +|`coder_version`|string|false||The Coder version of the server that the report was generated on.| +|`database`|[healthsdk.DatabaseReport](#healthsdkdatabasereport)|false||| +|`derp`|[healthsdk.DERPHealthReport](#healthsdkderphealthreport)|false||| +|`healthy`|boolean|false||Healthy is true if the report returns no errors. Deprecated: use `Severity` instead| +|`provisioner_daemons`|[healthsdk.ProvisionerDaemonsReport](#healthsdkprovisionerdaemonsreport)|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`|[healthsdk.WebsocketReport](#healthsdkwebsocketreport)|false||| +|`workspace_proxy`|[healthsdk.WorkspaceProxyReport](#healthsdkworkspaceproxyreport)|false||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## healthsdk.ProvisionerDaemonsReport @@ -11929,21 +11929,21 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|-------------------------------------------------------------------------------------------|----------|--------------|-------------| -| `dismissed` | boolean | false | | | -| `error` | string | false | | | -| `items` | array of [healthsdk.ProvisionerDaemonsReportItem](#healthsdkprovisionerdaemonsreportitem) | false | | | -| `severity` | [health.Severity](#healthseverity) | false | | | -| `warnings` | array of [health.Message](#healthmessage) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`dismissed`|boolean|false||| +|`error`|string|false||| +|`items`|array of [healthsdk.ProvisionerDaemonsReportItem](#healthsdkprovisionerdaemonsreportitem)|false||| +|`severity`|[health.Severity](#healthseverity)|false||| +|`warnings`|array of [health.Message](#healthmessage)|false||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## healthsdk.ProvisionerDaemonsReportItem @@ -11993,10 +11993,10 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------------|----------------------------------------------------------|----------|--------------|-------------| -| `provisioner_daemon` | [codersdk.ProvisionerDaemon](#codersdkprovisionerdaemon) | false | | | -| `warnings` | array of [health.Message](#healthmessage) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`provisioner_daemon`|[codersdk.ProvisionerDaemon](#codersdkprovisionerdaemon)|false||| +|`warnings`|array of [health.Message](#healthmessage)|false||| ## healthsdk.STUNReport @@ -12010,11 +12010,11 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| Name | Type | Required | Restrictions | Description | -|-----------|---------|----------|--------------|-------------| -| `canSTUN` | boolean | false | | | -| `enabled` | boolean | false | | | -| `error` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`canSTUN`|boolean|false||| +|`enabled`|boolean|false||| +|`error`|string|false||| ## healthsdk.UpdateHealthSettings @@ -12028,9 +12028,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------------|-------------------------------------------------------------|----------|--------------|-------------| -| `dismissed_healthchecks` | array of [healthsdk.HealthSection](#healthsdkhealthsection) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`dismissed_healthchecks`|array of [healthsdk.HealthSection](#healthsdkhealthsection)|false||| ## healthsdk.WebsocketReport @@ -12053,23 +12053,23 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| 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 [health.Message](#healthmessage) | false | | | +|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 [health.Message](#healthmessage)|false||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## healthsdk.WorkspaceProxyReport @@ -12121,22 +12121,22 @@ Zero means unspecified. There might be a limit, but the client need not try to r ### Properties -| 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. | -| `severity` | [health.Severity](#healthseverity) | false | | | -| `warnings` | array of [health.Message](#healthmessage) | false | | | -| `workspace_proxies` | [codersdk.RegionsResponse-codersdk_WorkspaceProxy](#codersdkregionsresponse-codersdk_workspaceproxy) | false | | | +|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.| +|`severity`|[health.Severity](#healthseverity)|false||| +|`warnings`|array of [health.Message](#healthmessage)|false||| +|`workspace_proxies`|[codersdk.RegionsResponse-codersdk_WorkspaceProxy](#codersdkregionsresponse-codersdk_workspaceproxy)|false||| #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +|Property|Value| +|---|---| +|`severity`|`ok`| +|`severity`|`warning`| +|`severity`|`error`| ## key.NodePublic @@ -12185,30 +12185,30 @@ None ### 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. | +|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.| ## oauth2.Token @@ -12224,10 +12224,10 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|----------------|---------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `access_token` | string | false | | Access token is the token that authorizes and authenticates the requests. | -| `expires_in` | integer | false | | Expires in is the OAuth2 wire format "expires_in" field, which specifies how many seconds later the token expires, relative to an unknown time base approximately around "now". It is the application's responsibility to populate `Expiry` from `ExpiresIn` when required. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`access_token`|string|false||Access token is the token that authorizes and authenticates the requests.| +|`expires_in`|integer|false||Expires in is the OAuth2 wire format "expires_in" field, which specifies how many seconds later the token expires, relative to an unknown time base approximately around "now". It is the application's responsibility to populate `Expiry` from `ExpiresIn` when required.| |`expiry`|string|false||Expiry is the optional expiration time of the access token. If zero, [TokenSource] implementations will reuse the same token forever and RefreshToken or equivalent mechanisms for that TokenSource will not be used.| |`refresh_token`|string|false||Refresh token is a token that's used by the application (as opposed to the user) to refresh the access token if it expires.| @@ -12254,9 +12254,9 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|--------|----------|--------------|-------------| -| `[any property]` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[any property]`|string|false||| ## serpent.Group @@ -12276,12 +12276,12 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|--------------------------------|----------|--------------|-------------| -| `description` | string | false | | | -| `name` | string | false | | | -| `parent` | [serpent.Group](#serpentgroup) | false | | | -| `yaml` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`description`|string|false||| +|`name`|string|false||| +|`parent`|[serpent.Group](#serpentgroup)|false||| +|`yaml`|string|false||| ## serpent.HostPort @@ -12294,10 +12294,10 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|--------|--------|----------|--------------|-------------| -| `host` | string | false | | | -| `port` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`host`|string|false||| +|`port`|string|false||| ## serpent.Option @@ -12365,22 +12365,22 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------|--------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| `annotations` | [serpent.Annotations](#serpentannotations) | false | | Annotations enable extensions to serpent 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` | [serpent.Group](#serpentgroup) | 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 [serpent.Option](#serpentoption) | 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` | [serpent.ValueSource](#serpentvaluesource) | false | | | -| `yaml` | string | false | | Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`annotations`|[serpent.Annotations](#serpentannotations)|false||Annotations enable extensions to serpent 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`|[serpent.Group](#serpentgroup)|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 [serpent.Option](#serpentoption)|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`|[serpent.ValueSource](#serpentvaluesource)|false||| +|`yaml`|string|false||Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled.| ## serpent.Regexp @@ -12422,9 +12422,9 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|---------------------------------------------------------------------|----------|--------------|-------------| -| `value` | array of [codersdk.ExternalAuthConfig](#codersdkexternalauthconfig) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`value`|array of [codersdk.ExternalAuthConfig](#codersdkexternalauthconfig)|false||| ## serpent.Struct-array_codersdk_LinkConfig @@ -12442,9 +12442,9 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|-----------------------------------------------------|----------|--------------|-------------| -| `value` | array of [codersdk.LinkConfig](#codersdklinkconfig) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`value`|array of [codersdk.LinkConfig](#codersdklinkconfig)|false||| ## serpent.URL @@ -12466,19 +12466,19 @@ None ### 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 (see Hostname and Port methods) | -| `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 | +|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 (see Hostname and Port methods)| +|`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| ## serpent.ValueSource @@ -12490,13 +12490,13 @@ None #### Enumerated Values -| Value | -|-----------| -| `` | -| `flag` | -| `env` | -| `yaml` | -| `default` | +|Value| +|---| +|``| +|`flag`| +|`env`| +|`yaml`| +|`default`| ## tailcfg.DERPHomeParams @@ -12618,10 +12618,10 @@ The numbers are not necessarily contiguous.| ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------|---------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `canPort80` | boolean | false | | Canport80 specifies whether this DERP node is accessible over HTTP on port 80 specifically. This is used for captive portal checks. | -| `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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`canPort80`|boolean|false||Canport80 specifies whether this DERP node is accessible over HTTP on port 80 specifically. This is used for captive portal checks.| +|`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.| @@ -12667,10 +12667,10 @@ It is required but need not be unique; multiple nodes may have the same HostName ### 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. | +|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.| @@ -12701,10 +12701,10 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|---------|----------|--------------|-----------------------------------| -| `uuid` | string | false | | | -| `valid` | boolean | false | | Valid is true if UUID is not NULL | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`uuid`|string|false||| +|`valid`|boolean|false||Valid is true if UUID is not NULL| ## workspaceapps.AccessMethod @@ -12716,11 +12716,11 @@ None #### Enumerated Values -| Value | -|-------------| -| `path` | -| `subdomain` | -| `terminal` | +|Value| +|---| +|`path`| +|`subdomain`| +|`terminal`| ## workspaceapps.IssueTokenRequest @@ -12745,14 +12745,14 @@ None ### 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. | +|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 @@ -12770,15 +12770,15 @@ None ### 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. | -| `app_prefix` | string | false | | Prefix is the prefix of the subdomain app URL. Prefix should have a trailing "---" if set. | -| `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 | | | +|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.| +|`app_prefix`|string|false||Prefix is the prefix of the subdomain app URL. Prefix should have a trailing "---" if set.| +|`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||| ## workspaceapps.StatsReport @@ -12798,17 +12798,17 @@ None ### 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 | | | +|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||| ## workspacesdk.AgentConnectionInfo @@ -12881,12 +12881,12 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|------------------------------|------------------------------------|----------|--------------|-------------| -| `derp_force_websockets` | boolean | false | | | -| `derp_map` | [tailcfg.DERPMap](#tailcfgderpmap) | false | | | -| `disable_direct_connections` | boolean | false | | | -| `hostname_suffix` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`derp_force_websockets`|boolean|false||| +|`derp_map`|[tailcfg.DERPMap](#tailcfgderpmap)|false||| +|`disable_direct_connections`|boolean|false||| +|`hostname_suffix`|string|false||| ## wsproxysdk.CryptoKeysResponse @@ -12906,9 +12906,9 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|---------------|---------------------------------------------------|----------|--------------|-------------| -| `crypto_keys` | array of [codersdk.CryptoKey](#codersdkcryptokey) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`crypto_keys`|array of [codersdk.CryptoKey](#codersdkcryptokey)|false||| ## wsproxysdk.DeregisterWorkspaceProxyRequest @@ -12920,9 +12920,9 @@ None ### 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. | +|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.| ## wsproxysdk.IssueSignedAppTokenResponse @@ -12934,9 +12934,9 @@ None ### Properties -| Name | Type | Required | Restrictions | Description | -|--------------------|--------|----------|--------------|-------------------------------------------------------------| -| `signed_token_str` | string | false | | Signed token str should be set as a cookie on the response. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`signed_token_str`|string|false||Signed token str should be set as a cookie on the response.| ## wsproxysdk.RegisterWorkspaceProxyRequest @@ -12956,12 +12956,12 @@ None ### Properties -| 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. | -| `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. | -| `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. | +|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.| +|`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.| +|`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.| @@ -13051,13 +13051,13 @@ This value is only stored on subsequent requests to the register endpoint, not t ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------|-----------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------| -| `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. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`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.| ## wsproxysdk.ReportAppStatsRequest @@ -13081,6 +13081,6 @@ This value is only stored on subsequent requests to the register endpoint, not t ### Properties -| Name | Type | Required | Restrictions | Description | -|---------|-----------------------------------------------------------------|----------|--------------|-------------| -| `stats` | array of [workspaceapps.StatsReport](#workspaceappsstatsreport) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`stats`|array of [workspaceapps.StatsReport](#workspaceappsstatsreport)|false||| diff --git a/docs/reference/api/templates.md b/docs/reference/api/templates.md index d0c7082ef74aa..c5cbdf19c1a40 100644 --- a/docs/reference/api/templates.md +++ b/docs/reference/api/templates.md @@ -19,9 +19,9 @@ To include deprecated templates, specify `deprecated:true` in the search query. ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -86,26 +86,26 @@ To include deprecated templates, specify `deprecated:true` in the search query. ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Template](schemas.md#codersdktemplate) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Template](schemas.md#codersdktemplate)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|--------------------------------------|------------------------------------------------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» active_user_count` | integer | false | | Active user count is set to -1 when loading. | -| `» active_version_id` | string(uuid) | false | | | -| `» activity_bump_ms` | integer | false | | | -| `» 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](schemas.md#codersdktemplateautostartrequirement) | false | | | -| `»» days_of_week` | array | false | | Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed. | -| `» autostop_requirement` | [codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement) | false | | Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» active_user_count`|integer|false||Active user count is set to -1 when loading.| +|`» active_version_id`|string(uuid)|false||| +|`» activity_bump_ms`|integer|false||| +|`» 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](schemas.md#codersdktemplateautostartrequirement)|false||| +|`»» days_of_week`|array|false||Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed.| +|`» autostop_requirement`|[codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement)|false||Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature.| |`»» days_of_week`|array|false||Days of week is a list of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required. Weekdays cannot be specified twice. 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.| @@ -139,13 +139,13 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Property | Value | -|------------------------|-----------------| -| `max_port_share_level` | `owner` | -| `max_port_share_level` | `authenticated` | -| `max_port_share_level` | `organization` | -| `max_port_share_level` | `public` | -| `provisioner` | `terraform` | +|Property|Value| +|---|---| +|`max_port_share_level`|`owner`| +|`max_port_share_level`|`authenticated`| +|`max_port_share_level`|`organization`| +|`max_port_share_level`|`public`| +|`provisioner`|`terraform`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -200,10 +200,10 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|----------------------------------------------------------------------------|----------|-----------------| -| `organization` | path | string | true | Organization ID | -| `body` | body | [codersdk.CreateTemplateRequest](schemas.md#codersdkcreatetemplaterequest) | true | Request body | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string|true|Organization ID| +|`body`|body|[codersdk.CreateTemplateRequest](schemas.md#codersdkcreatetemplaterequest)|true|Request body| ### Example responses @@ -266,9 +266,9 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Template](schemas.md#codersdktemplate)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -287,9 +287,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| ### Example responses @@ -313,24 +313,24 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateExample](schemas.md#codersdktemplateexample) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.TemplateExample](schemas.md#codersdktemplateexample)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-----------------|--------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» description` | string | false | | | -| `» icon` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» markdown` | string | false | | | -| `» name` | string | false | | | -| `» tags` | array | false | | | -| `» url` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» description`|string|false||| +|`» icon`|string|false||| +|`» id`|string(uuid)|false||| +|`» markdown`|string|false||| +|`» name`|string|false||| +|`» tags`|array|false||| +|`» url`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -349,10 +349,10 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|--------------|----------|-----------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `templatename` | path | string | true | Template name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`templatename`|path|string|true|Template name| ### Example responses @@ -415,9 +415,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Template](schemas.md#codersdktemplate)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -436,11 +436,11 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat ### Parameters -| Name | In | Type | Required | Description | -|-----------------------|------|--------------|----------|-----------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `templatename` | path | string | true | Template name | -| `templateversionname` | path | string | true | Template version name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`templatename`|path|string|true|Template name| +|`templateversionname`|path|string|true|Template version name| ### Example responses @@ -513,9 +513,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.TemplateVersion](schemas.md#codersdktemplateversion)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -534,11 +534,11 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat ### Parameters -| Name | In | Type | Required | Description | -|-----------------------|------|--------------|----------|-----------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `templatename` | path | string | true | Template name | -| `templateversionname` | path | string | true | Template version name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`templatename`|path|string|true|Template name| +|`templateversionname`|path|string|true|Template version name| ### Example responses @@ -611,9 +611,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.TemplateVersion](schemas.md#codersdktemplateversion)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -657,10 +657,10 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|------------------------------------------------------------------------------------------|----------|---------------------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `body` | body | [codersdk.CreateTemplateVersionRequest](schemas.md#codersdkcreatetemplateversionrequest) | true | Create template version request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`body`|body|[codersdk.CreateTemplateVersionRequest](schemas.md#codersdkcreatetemplateversionrequest)|true|Create template version request| ### Example responses @@ -733,9 +733,9 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|----------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.TemplateVersion](schemas.md#codersdktemplateversion)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -819,26 +819,26 @@ To include deprecated templates, specify `deprecated:true` in the search query. ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Template](schemas.md#codersdktemplate) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Template](schemas.md#codersdktemplate)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|--------------------------------------|------------------------------------------------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» active_user_count` | integer | false | | Active user count is set to -1 when loading. | -| `» active_version_id` | string(uuid) | false | | | -| `» activity_bump_ms` | integer | false | | | -| `» 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](schemas.md#codersdktemplateautostartrequirement) | false | | | -| `»» days_of_week` | array | false | | Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed. | -| `» autostop_requirement` | [codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement) | false | | Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature. | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» active_user_count`|integer|false||Active user count is set to -1 when loading.| +|`» active_version_id`|string(uuid)|false||| +|`» activity_bump_ms`|integer|false||| +|`» 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](schemas.md#codersdktemplateautostartrequirement)|false||| +|`»» days_of_week`|array|false||Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed.| +|`» autostop_requirement`|[codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement)|false||Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature.| |`»» days_of_week`|array|false||Days of week is a list of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required. Weekdays cannot be specified twice. 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.| @@ -872,13 +872,13 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Property | Value | -|------------------------|-----------------| -| `max_port_share_level` | `owner` | -| `max_port_share_level` | `authenticated` | -| `max_port_share_level` | `organization` | -| `max_port_share_level` | `public` | -| `provisioner` | `terraform` | +|Property|Value| +|---|---| +|`max_port_share_level`|`owner`| +|`max_port_share_level`|`authenticated`| +|`max_port_share_level`|`organization`| +|`max_port_share_level`|`public`| +|`provisioner`|`terraform`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -917,24 +917,24 @@ curl -X GET http://coder-server:8080/api/v2/templates/examples \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateExample](schemas.md#codersdktemplateexample) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.TemplateExample](schemas.md#codersdktemplateexample)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-----------------|--------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» description` | string | false | | | -| `» icon` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» markdown` | string | false | | | -| `» name` | string | false | | | -| `» tags` | array | false | | | -| `» url` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» description`|string|false||| +|`» icon`|string|false||| +|`» id`|string(uuid)|false||| +|`» markdown`|string|false||| +|`» name`|string|false||| +|`» tags`|array|false||| +|`» url`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -953,9 +953,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template} \ ### Parameters -| Name | In | Type | Required | Description | -|------------|------|--------------|----------|-------------| -| `template` | path | string(uuid) | true | Template ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| ### Example responses @@ -1018,9 +1018,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Template](schemas.md#codersdktemplate)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1039,9 +1039,9 @@ curl -X DELETE http://coder-server:8080/api/v2/templates/{template} \ ### Parameters -| Name | In | Type | Required | Description | -|------------|------|--------------|----------|-------------| -| `template` | path | string(uuid) | true | Template ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| ### Example responses @@ -1062,9 +1062,9 @@ curl -X DELETE http://coder-server:8080/api/v2/templates/{template} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1083,9 +1083,9 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template} \ ### Parameters -| Name | In | Type | Required | Description | -|------------|------|--------------|----------|-------------| -| `template` | path | string(uuid) | true | Template ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| ### Example responses @@ -1148,9 +1148,9 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Template](schemas.md#codersdktemplate)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1169,9 +1169,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/daus \ ### Parameters -| Name | In | Type | Required | Description | -|------------|------|--------------|----------|-------------| -| `template` | path | string(uuid) | true | Template ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| ### Example responses @@ -1191,9 +1191,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/daus \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DAUsResponse](schemas.md#codersdkdausresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.DAUsResponse](schemas.md#codersdkdausresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1212,13 +1212,13 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \ ### Parameters -| Name | In | Type | Required | Description | -|--------------------|-------|--------------|----------|---------------------------------------| -| `template` | path | string(uuid) | true | Template ID | -| `after_id` | query | string(uuid) | false | After ID | -| `include_archived` | query | boolean | false | Include archived versions in the list | -| `limit` | query | integer | false | Page limit | -| `offset` | query | integer | false | Page offset | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| +|`after_id`|query|string(uuid)|false|After ID| +|`include_archived`|query|boolean|false|Include archived versions in the list| +|`limit`|query|integer|false|Page limit| +|`offset`|query|integer|false|Page offset| ### Example responses @@ -1293,81 +1293,81 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.TemplateVersion](schemas.md#codersdktemplateversion)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-----------------------------|------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» archived` | boolean | false | | | -| `» created_at` | string(date-time) | false | | | -| `» created_by` | [codersdk.MinimalUser](schemas.md#codersdkminimaluser) | false | | | -| `»» avatar_url` | string(uri) | false | | | -| `»» id` | string(uuid) | true | | | -| `»» username` | string | true | | | -| `» id` | string(uuid) | false | | | -| `» job` | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | false | | | -| `»» available_workers` | array | false | | | -| `»» canceled_at` | string(date-time) | false | | | -| `»» completed_at` | string(date-time) | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» error` | string | false | | | -| `»» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | | -| `»» file_id` | string(uuid) | false | | | -| `»» id` | string(uuid) | false | | | -| `»» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | | -| `»»» error` | string | false | | | -| `»»» template_version_id` | string(uuid) | false | | | -| `»»» workspace_build_id` | string(uuid) | false | | | -| `»» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | | -| `»»» template_display_name` | string | false | | | -| `»»» template_icon` | string | false | | | -| `»»» template_id` | string(uuid) | false | | | -| `»»» template_name` | string | false | | | -| `»»» template_version_name` | string | false | | | -| `»»» workspace_id` | string(uuid) | false | | | -| `»»» workspace_name` | string | false | | | -| `»» organization_id` | string(uuid) | false | | | -| `»» queue_position` | integer | false | | | -| `»» queue_size` | integer | false | | | -| `»» started_at` | string(date-time) | false | | | -| `»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | | -| `»» tags` | object | false | | | -| `»»» [any property]` | string | false | | | -| `»» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | | -| `»» worker_id` | string(uuid) | false | | | -| `»» worker_name` | string | false | | | -| `» matched_provisioners` | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | false | | | -| `»» available` | integer | false | | Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped. | -| `»» count` | integer | false | | Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags. | -| `»» most_recently_seen` | string(date-time) | false | | Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null. | -| `» message` | string | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» readme` | string | false | | | -| `» template_id` | string(uuid) | false | | | -| `» updated_at` | string(date-time) | false | | | -| `» warnings` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» archived`|boolean|false||| +|`» created_at`|string(date-time)|false||| +|`» created_by`|[codersdk.MinimalUser](schemas.md#codersdkminimaluser)|false||| +|`»» avatar_url`|string(uri)|false||| +|`»» id`|string(uuid)|true||| +|`»» username`|string|true||| +|`» id`|string(uuid)|false||| +|`» job`|[codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob)|false||| +|`»» available_workers`|array|false||| +|`»» canceled_at`|string(date-time)|false||| +|`»» completed_at`|string(date-time)|false||| +|`»» created_at`|string(date-time)|false||| +|`»» error`|string|false||| +|`»» error_code`|[codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode)|false||| +|`»» file_id`|string(uuid)|false||| +|`»» id`|string(uuid)|false||| +|`»» input`|[codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput)|false||| +|`»»» error`|string|false||| +|`»»» template_version_id`|string(uuid)|false||| +|`»»» workspace_build_id`|string(uuid)|false||| +|`»» metadata`|[codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata)|false||| +|`»»» template_display_name`|string|false||| +|`»»» template_icon`|string|false||| +|`»»» template_id`|string(uuid)|false||| +|`»»» template_name`|string|false||| +|`»»» template_version_name`|string|false||| +|`»»» workspace_id`|string(uuid)|false||| +|`»»» workspace_name`|string|false||| +|`»» organization_id`|string(uuid)|false||| +|`»» queue_position`|integer|false||| +|`»» queue_size`|integer|false||| +|`»» started_at`|string(date-time)|false||| +|`»» status`|[codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus)|false||| +|`»» tags`|object|false||| +|`»»» [any property]`|string|false||| +|`»» type`|[codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype)|false||| +|`»» worker_id`|string(uuid)|false||| +|`»» worker_name`|string|false||| +|`» matched_provisioners`|[codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners)|false||| +|`»» available`|integer|false||Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped.| +|`»» count`|integer|false||Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags.| +|`»» most_recently_seen`|string(date-time)|false||Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null.| +|`» message`|string|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» readme`|string|false||| +|`» template_id`|string(uuid)|false||| +|`» updated_at`|string(date-time)|false||| +|`» warnings`|array|false||| #### Enumerated Values -| Property | Value | -|--------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `type` | `template_version_import` | -| `type` | `workspace_build` | -| `type` | `template_version_dry_run` | +|Property|Value| +|---|---| +|`error_code`|`REQUIRED_TEMPLATE_VARIABLES`| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| +|`type`|`template_version_import`| +|`type`|`workspace_build`| +|`type`|`template_version_dry_run`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1395,10 +1395,10 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/versions \ ### Parameters -| Name | In | Type | Required | Description | -|------------|------|----------------------------------------------------------------------------------------|----------|---------------------------| -| `template` | path | string(uuid) | true | Template ID | -| `body` | body | [codersdk.UpdateActiveTemplateVersion](schemas.md#codersdkupdateactivetemplateversion) | true | Modified template version | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| +|`body`|body|[codersdk.UpdateActiveTemplateVersion](schemas.md#codersdkupdateactivetemplateversion)|true|Modified template version| ### Example responses @@ -1419,9 +1419,9 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/versions \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1449,10 +1449,10 @@ curl -X POST http://coder-server:8080/api/v2/templates/{template}/versions/archi ### Parameters -| Name | In | Type | Required | Description | -|------------|------|----------------------------------------------------------------------------------------------|----------|-----------------| -| `template` | path | string(uuid) | true | Template ID | -| `body` | body | [codersdk.ArchiveTemplateVersionsRequest](schemas.md#codersdkarchivetemplateversionsrequest) | true | Archive request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| +|`body`|body|[codersdk.ArchiveTemplateVersionsRequest](schemas.md#codersdkarchivetemplateversionsrequest)|true|Archive request| ### Example responses @@ -1473,9 +1473,9 @@ curl -X POST http://coder-server:8080/api/v2/templates/{template}/versions/archi ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1494,10 +1494,10 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ ### Parameters -| Name | In | Type | Required | Description | -|-----------------------|------|--------------|----------|-----------------------| -| `template` | path | string(uuid) | true | Template ID | -| `templateversionname` | path | string | true | Template version name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`template`|path|string(uuid)|true|Template ID| +|`templateversionname`|path|string|true|Template version name| ### Example responses @@ -1572,81 +1572,81 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.TemplateVersion](schemas.md#codersdktemplateversion)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-----------------------------|------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» archived` | boolean | false | | | -| `» created_at` | string(date-time) | false | | | -| `» created_by` | [codersdk.MinimalUser](schemas.md#codersdkminimaluser) | false | | | -| `»» avatar_url` | string(uri) | false | | | -| `»» id` | string(uuid) | true | | | -| `»» username` | string | true | | | -| `» id` | string(uuid) | false | | | -| `» job` | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | false | | | -| `»» available_workers` | array | false | | | -| `»» canceled_at` | string(date-time) | false | | | -| `»» completed_at` | string(date-time) | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» error` | string | false | | | -| `»» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | | -| `»» file_id` | string(uuid) | false | | | -| `»» id` | string(uuid) | false | | | -| `»» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | | -| `»»» error` | string | false | | | -| `»»» template_version_id` | string(uuid) | false | | | -| `»»» workspace_build_id` | string(uuid) | false | | | -| `»» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | | -| `»»» template_display_name` | string | false | | | -| `»»» template_icon` | string | false | | | -| `»»» template_id` | string(uuid) | false | | | -| `»»» template_name` | string | false | | | -| `»»» template_version_name` | string | false | | | -| `»»» workspace_id` | string(uuid) | false | | | -| `»»» workspace_name` | string | false | | | -| `»» organization_id` | string(uuid) | false | | | -| `»» queue_position` | integer | false | | | -| `»» queue_size` | integer | false | | | -| `»» started_at` | string(date-time) | false | | | -| `»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | | -| `»» tags` | object | false | | | -| `»»» [any property]` | string | false | | | -| `»» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | | -| `»» worker_id` | string(uuid) | false | | | -| `»» worker_name` | string | false | | | -| `» matched_provisioners` | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | false | | | -| `»» available` | integer | false | | Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped. | -| `»» count` | integer | false | | Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags. | -| `»» most_recently_seen` | string(date-time) | false | | Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null. | -| `» message` | string | false | | | -| `» name` | string | false | | | -| `» organization_id` | string(uuid) | false | | | -| `» readme` | string | false | | | -| `» template_id` | string(uuid) | false | | | -| `» updated_at` | string(date-time) | false | | | -| `» warnings` | array | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» archived`|boolean|false||| +|`» created_at`|string(date-time)|false||| +|`» created_by`|[codersdk.MinimalUser](schemas.md#codersdkminimaluser)|false||| +|`»» avatar_url`|string(uri)|false||| +|`»» id`|string(uuid)|true||| +|`»» username`|string|true||| +|`» id`|string(uuid)|false||| +|`» job`|[codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob)|false||| +|`»» available_workers`|array|false||| +|`»» canceled_at`|string(date-time)|false||| +|`»» completed_at`|string(date-time)|false||| +|`»» created_at`|string(date-time)|false||| +|`»» error`|string|false||| +|`»» error_code`|[codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode)|false||| +|`»» file_id`|string(uuid)|false||| +|`»» id`|string(uuid)|false||| +|`»» input`|[codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput)|false||| +|`»»» error`|string|false||| +|`»»» template_version_id`|string(uuid)|false||| +|`»»» workspace_build_id`|string(uuid)|false||| +|`»» metadata`|[codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata)|false||| +|`»»» template_display_name`|string|false||| +|`»»» template_icon`|string|false||| +|`»»» template_id`|string(uuid)|false||| +|`»»» template_name`|string|false||| +|`»»» template_version_name`|string|false||| +|`»»» workspace_id`|string(uuid)|false||| +|`»»» workspace_name`|string|false||| +|`»» organization_id`|string(uuid)|false||| +|`»» queue_position`|integer|false||| +|`»» queue_size`|integer|false||| +|`»» started_at`|string(date-time)|false||| +|`»» status`|[codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus)|false||| +|`»» tags`|object|false||| +|`»»» [any property]`|string|false||| +|`»» type`|[codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype)|false||| +|`»» worker_id`|string(uuid)|false||| +|`»» worker_name`|string|false||| +|`» matched_provisioners`|[codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners)|false||| +|`»» available`|integer|false||Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped.| +|`»» count`|integer|false||Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags.| +|`»» most_recently_seen`|string(date-time)|false||Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null.| +|`» message`|string|false||| +|`» name`|string|false||| +|`» organization_id`|string(uuid)|false||| +|`» readme`|string|false||| +|`» template_id`|string(uuid)|false||| +|`» updated_at`|string(date-time)|false||| +|`» warnings`|array|false||| #### Enumerated Values -| Property | Value | -|--------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `type` | `template_version_import` | -| `type` | `workspace_build` | -| `type` | `template_version_dry_run` | +|Property|Value| +|---|---| +|`error_code`|`REQUIRED_TEMPLATE_VARIABLES`| +|`status`|`pending`| +|`status`|`running`| +|`status`|`succeeded`| +|`status`|`canceling`| +|`status`|`canceled`| +|`status`|`failed`| +|`type`|`template_version_import`| +|`type`|`workspace_build`| +|`type`|`template_version_dry_run`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1665,9 +1665,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \ ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -1740,9 +1740,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.TemplateVersion](schemas.md#codersdktemplateversion)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1771,10 +1771,10 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|----------------------------------------------------------------------------------------|----------|--------------------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | -| `body` | body | [codersdk.PatchTemplateVersionRequest](schemas.md#codersdkpatchtemplateversionrequest) | true | Patch template version request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| +|`body`|body|[codersdk.PatchTemplateVersionRequest](schemas.md#codersdkpatchtemplateversionrequest)|true|Patch template version request| ### Example responses @@ -1847,9 +1847,9 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.TemplateVersion](schemas.md#codersdktemplateversion)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1868,9 +1868,9 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/ ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -1891,9 +1891,9 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1912,9 +1912,9 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -1935,9 +1935,9 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1977,10 +1977,10 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/ ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|------------------------------------------------------------------------------------------------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | -| `body` | body | [codersdk.CreateTemplateVersionDryRunRequest](schemas.md#codersdkcreatetemplateversiondryrunrequest) | true | Dry-run request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| +|`body`|body|[codersdk.CreateTemplateVersionDryRunRequest](schemas.md#codersdkcreatetemplateversiondryrunrequest)|true|Dry-run request| ### Example responses @@ -2029,9 +2029,9 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2050,10 +2050,10 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | -| `jobID` | path | string(uuid) | true | Job ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| +|`jobID`|path|string(uuid)|true|Job ID| ### Example responses @@ -2102,9 +2102,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2123,10 +2123,10 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `jobID` | path | string(uuid) | true | Job ID | -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`jobID`|path|string(uuid)|true|Job ID| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -2147,9 +2147,9 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2168,13 +2168,13 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Parameters -| Name | In | Type | Required | Description | -|-------------------|-------|--------------|----------|-----------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | -| `jobID` | path | string(uuid) | true | Job ID | -| `before` | query | integer | false | Before Unix timestamp | -| `after` | query | integer | false | After Unix timestamp | -| `follow` | query | boolean | false | Follow log stream | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| +|`jobID`|path|string(uuid)|true|Job ID| +|`before`|query|integer|false|Before Unix timestamp| +|`after`|query|integer|false|After Unix timestamp| +|`follow`|query|boolean|false|Follow log stream| ### Example responses @@ -2195,35 +2195,35 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|----------------------------------------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | false | | | -| `» id` | integer | false | | | -| `» log_level` | [codersdk.LogLevel](schemas.md#codersdkloglevel) | false | | | -| `» log_source` | [codersdk.LogSource](schemas.md#codersdklogsource) | false | | | -| `» output` | string | false | | | -| `» stage` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|false||| +|`» id`|integer|false||| +|`» log_level`|[codersdk.LogLevel](schemas.md#codersdkloglevel)|false||| +|`» log_source`|[codersdk.LogSource](schemas.md#codersdklogsource)|false||| +|`» output`|string|false||| +|`» stage`|string|false||| #### Enumerated Values -| Property | Value | -|--------------|----------------------| -| `log_level` | `trace` | -| `log_level` | `debug` | -| `log_level` | `info` | -| `log_level` | `warn` | -| `log_level` | `error` | -| `log_source` | `provisioner_daemon` | -| `log_source` | `provisioner` | +|Property|Value| +|---|---| +|`log_level`|`trace`| +|`log_level`|`debug`| +|`log_level`|`info`| +|`log_level`|`warn`| +|`log_level`|`error`| +|`log_source`|`provisioner_daemon`| +|`log_source`|`provisioner`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2242,10 +2242,10 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | -| `jobID` | path | string(uuid) | true | Job ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| +|`jobID`|path|string(uuid)|true|Job ID| ### Example responses @@ -2261,9 +2261,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2282,10 +2282,10 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | -| `jobID` | path | string(uuid) | true | Job ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| +|`jobID`|path|string(uuid)|true|Job ID| ### Example responses @@ -2432,153 +2432,153 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|---------------------------------|--------------------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» agents` | array | false | | | -| `»» api_version` | string | false | | | -| `»» apps` | array | false | | | -| `»»» command` | string | false | | | -| `»»» display_name` | string | false | | Display name is a friendly name for the app. | -| `»»» external` | boolean | false | | External specifies whether the URL should be opened externally on the client or not. | -| `»»» group` | string | false | | | -| `»»» health` | [codersdk.WorkspaceAppHealth](schemas.md#codersdkworkspaceapphealth) | false | | | -| `»»» healthcheck` | [codersdk.Healthcheck](schemas.md#codersdkhealthcheck) | false | | Healthcheck specifies the configuration for checking app health. | -| `»»»» interval` | integer | false | | Interval specifies the seconds between each health check. | -| `»»»» threshold` | integer | false | | Threshold specifies the number of consecutive failed health checks before returning "unhealthy". | -| `»»»» url` | string | false | | URL specifies the endpoint to check for the app health. | -| `»»» hidden` | boolean | false | | | -| `»»» icon` | string | false | | Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. | -| `»»» id` | string(uuid) | false | | | -| `»»» open_in` | [codersdk.WorkspaceAppOpenIn](schemas.md#codersdkworkspaceappopenin) | false | | | -| `»»» sharing_level` | [codersdk.WorkspaceAppSharingLevel](schemas.md#codersdkworkspaceappsharinglevel) | false | | | -| `»»» slug` | string | false | | Slug is a unique identifier within the agent. | -| `»»» statuses` | array | false | | Statuses is a list of statuses for the app. | -| `»»»» agent_id` | string(uuid) | false | | | -| `»»»» app_id` | string(uuid) | false | | | -| `»»»» created_at` | string(date-time) | false | | | -| `»»»» icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. | -| `»»»» id` | string(uuid) | false | | | -| `»»»» message` | string | false | | | -| `»»»» needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. | -| `»»»» state` | [codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate) | false | | | -| `»»»» uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file | -| `»»»» workspace_id` | string(uuid) | false | | | -| `»»» subdomain` | boolean | false | | Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI. | -| `»»» subdomain_name` | string | false | | Subdomain name is the application domain exposed on the `coder server`. | -| `»»» url` | string | false | | URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client. | -| `»» architecture` | string | false | | | -| `»» connection_timeout_seconds` | integer | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» directory` | string | false | | | -| `»» disconnected_at` | string(date-time) | false | | | -| `»» display_apps` | array | false | | | -| `»» environment_variables` | object | false | | | -| `»»» [any property]` | string | false | | | -| `»» expanded_directory` | string | false | | | -| `»» first_connected_at` | string(date-time) | false | | | -| `»» health` | [codersdk.WorkspaceAgentHealth](schemas.md#codersdkworkspaceagenthealth) | false | | Health reports the health of the agent. | -| `»»» healthy` | boolean | false | | Healthy is true if the agent is healthy. | -| `»»» reason` | string | false | | Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true. | -| `»» id` | string(uuid) | false | | | -| `»» instance_id` | string | false | | | -| `»» last_connected_at` | string(date-time) | false | | | -| `»» latency` | object | false | | Latency is mapped by region name (e.g. "New York City", "Seattle"). | -| `»»» [any property]` | [codersdk.DERPRegion](schemas.md#codersdkderpregion) | false | | | -| `»»»» latency_ms` | number | false | | | -| `»»»» preferred` | boolean | false | | | -| `»» lifecycle_state` | [codersdk.WorkspaceAgentLifecycle](schemas.md#codersdkworkspaceagentlifecycle) | false | | | -| `»» log_sources` | array | false | | | -| `»»» created_at` | string(date-time) | false | | | -| `»»» display_name` | string | false | | | -| `»»» icon` | string | false | | | -| `»»» id` | string(uuid) | false | | | -| `»»» workspace_agent_id` | string(uuid) | false | | | -| `»» logs_length` | integer | false | | | -| `»» logs_overflowed` | boolean | false | | | -| `»» name` | string | false | | | -| `»» operating_system` | string | false | | | -| `»» parent_id` | [uuid.NullUUID](schemas.md#uuidnulluuid) | false | | | -| `»»» uuid` | string | false | | | -| `»»» valid` | boolean | false | | Valid is true if UUID is not NULL | -| `»» ready_at` | string(date-time) | false | | | -| `»» resource_id` | string(uuid) | false | | | -| `»» scripts` | array | false | | | -| `»»» cron` | string | false | | | -| `»»» display_name` | string | false | | | -| `»»» id` | string(uuid) | false | | | -| `»»» log_path` | string | false | | | -| `»»» log_source_id` | string(uuid) | false | | | -| `»»» run_on_start` | boolean | false | | | -| `»»» run_on_stop` | boolean | false | | | -| `»»» script` | string | false | | | -| `»»» start_blocks_login` | boolean | false | | | -| `»»» timeout` | integer | false | | | -| `»» started_at` | string(date-time) | false | | | -| `»» startup_script_behavior` | [codersdk.WorkspaceAgentStartupScriptBehavior](schemas.md#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](schemas.md#codersdkworkspaceagentstatus) | false | | | -| `»» subsystems` | array | false | | | -| `»» troubleshooting_url` | string | false | | | -| `»» updated_at` | string(date-time) | false | | | -| `»» version` | string | false | | | -| `» created_at` | string(date-time) | false | | | -| `» daily_cost` | integer | false | | | -| `» hide` | boolean | false | | | -| `» icon` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» job_id` | string(uuid) | false | | | -| `» metadata` | array | false | | | -| `»» key` | string | false | | | -| `»» sensitive` | boolean | false | | | -| `»» value` | string | false | | | -| `» name` | string | false | | | -| `» type` | string | false | | | -| `» workspace_transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» agents`|array|false||| +|`»» api_version`|string|false||| +|`»» apps`|array|false||| +|`»»» command`|string|false||| +|`»»» display_name`|string|false||Display name is a friendly name for the app.| +|`»»» external`|boolean|false||External specifies whether the URL should be opened externally on the client or not.| +|`»»» group`|string|false||| +|`»»» health`|[codersdk.WorkspaceAppHealth](schemas.md#codersdkworkspaceapphealth)|false||| +|`»»» healthcheck`|[codersdk.Healthcheck](schemas.md#codersdkhealthcheck)|false||Healthcheck specifies the configuration for checking app health.| +|`»»»» interval`|integer|false||Interval specifies the seconds between each health check.| +|`»»»» threshold`|integer|false||Threshold specifies the number of consecutive failed health checks before returning "unhealthy".| +|`»»»» url`|string|false||URL specifies the endpoint to check for the app health.| +|`»»» hidden`|boolean|false||| +|`»»» icon`|string|false||Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.| +|`»»» id`|string(uuid)|false||| +|`»»» open_in`|[codersdk.WorkspaceAppOpenIn](schemas.md#codersdkworkspaceappopenin)|false||| +|`»»» sharing_level`|[codersdk.WorkspaceAppSharingLevel](schemas.md#codersdkworkspaceappsharinglevel)|false||| +|`»»» slug`|string|false||Slug is a unique identifier within the agent.| +|`»»» statuses`|array|false||Statuses is a list of statuses for the app.| +|`»»»» agent_id`|string(uuid)|false||| +|`»»»» app_id`|string(uuid)|false||| +|`»»»» created_at`|string(date-time)|false||| +|`»»»» icon`|string|false||Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI.| +|`»»»» id`|string(uuid)|false||| +|`»»»» message`|string|false||| +|`»»»» needs_user_attention`|boolean|false||Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention.| +|`»»»» state`|[codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate)|false||| +|`»»»» uri`|string|false||Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file| +|`»»»» workspace_id`|string(uuid)|false||| +|`»»» subdomain`|boolean|false||Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.| +|`»»» subdomain_name`|string|false||Subdomain name is the application domain exposed on the `coder server`.| +|`»»» url`|string|false||URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.| +|`»» architecture`|string|false||| +|`»» connection_timeout_seconds`|integer|false||| +|`»» created_at`|string(date-time)|false||| +|`»» directory`|string|false||| +|`»» disconnected_at`|string(date-time)|false||| +|`»» display_apps`|array|false||| +|`»» environment_variables`|object|false||| +|`»»» [any property]`|string|false||| +|`»» expanded_directory`|string|false||| +|`»» first_connected_at`|string(date-time)|false||| +|`»» health`|[codersdk.WorkspaceAgentHealth](schemas.md#codersdkworkspaceagenthealth)|false||Health reports the health of the agent.| +|`»»» healthy`|boolean|false||Healthy is true if the agent is healthy.| +|`»»» reason`|string|false||Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.| +|`»» id`|string(uuid)|false||| +|`»» instance_id`|string|false||| +|`»» last_connected_at`|string(date-time)|false||| +|`»» latency`|object|false||Latency is mapped by region name (e.g. "New York City", "Seattle").| +|`»»» [any property]`|[codersdk.DERPRegion](schemas.md#codersdkderpregion)|false||| +|`»»»» latency_ms`|number|false||| +|`»»»» preferred`|boolean|false||| +|`»» lifecycle_state`|[codersdk.WorkspaceAgentLifecycle](schemas.md#codersdkworkspaceagentlifecycle)|false||| +|`»» log_sources`|array|false||| +|`»»» created_at`|string(date-time)|false||| +|`»»» display_name`|string|false||| +|`»»» icon`|string|false||| +|`»»» id`|string(uuid)|false||| +|`»»» workspace_agent_id`|string(uuid)|false||| +|`»» logs_length`|integer|false||| +|`»» logs_overflowed`|boolean|false||| +|`»» name`|string|false||| +|`»» operating_system`|string|false||| +|`»» parent_id`|[uuid.NullUUID](schemas.md#uuidnulluuid)|false||| +|`»»» uuid`|string|false||| +|`»»» valid`|boolean|false||Valid is true if UUID is not NULL| +|`»» ready_at`|string(date-time)|false||| +|`»» resource_id`|string(uuid)|false||| +|`»» scripts`|array|false||| +|`»»» cron`|string|false||| +|`»»» display_name`|string|false||| +|`»»» id`|string(uuid)|false||| +|`»»» log_path`|string|false||| +|`»»» log_source_id`|string(uuid)|false||| +|`»»» run_on_start`|boolean|false||| +|`»»» run_on_stop`|boolean|false||| +|`»»» script`|string|false||| +|`»»» start_blocks_login`|boolean|false||| +|`»»» timeout`|integer|false||| +|`»» started_at`|string(date-time)|false||| +|`»» startup_script_behavior`|[codersdk.WorkspaceAgentStartupScriptBehavior](schemas.md#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](schemas.md#codersdkworkspaceagentstatus)|false||| +|`»» subsystems`|array|false||| +|`»» troubleshooting_url`|string|false||| +|`»» updated_at`|string(date-time)|false||| +|`»» version`|string|false||| +|`» created_at`|string(date-time)|false||| +|`» daily_cost`|integer|false||| +|`» hide`|boolean|false||| +|`» icon`|string|false||| +|`» id`|string(uuid)|false||| +|`» job_id`|string(uuid)|false||| +|`» metadata`|array|false||| +|`»» key`|string|false||| +|`»» sensitive`|boolean|false||| +|`»» value`|string|false||| +|`» name`|string|false||| +|`» type`|string|false||| +|`» workspace_transition`|[codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition)|false||| #### Enumerated Values -| Property | Value | -|---------------------------|--------------------| -| `health` | `disabled` | -| `health` | `initializing` | -| `health` | `healthy` | -| `health` | `unhealthy` | -| `open_in` | `slim-window` | -| `open_in` | `tab` | -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | -| `state` | `working` | -| `state` | `idle` | -| `state` | `complete` | -| `state` | `failure` | -| `lifecycle_state` | `created` | -| `lifecycle_state` | `starting` | -| `lifecycle_state` | `start_timeout` | -| `lifecycle_state` | `start_error` | -| `lifecycle_state` | `ready` | -| `lifecycle_state` | `shutting_down` | -| `lifecycle_state` | `shutdown_timeout` | -| `lifecycle_state` | `shutdown_error` | -| `lifecycle_state` | `off` | -| `startup_script_behavior` | `blocking` | -| `startup_script_behavior` | `non-blocking` | -| `status` | `connecting` | -| `status` | `connected` | -| `status` | `disconnected` | -| `status` | `timeout` | -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | +|Property|Value| +|---|---| +|`health`|`disabled`| +|`health`|`initializing`| +|`health`|`healthy`| +|`health`|`unhealthy`| +|`open_in`|`slim-window`| +|`open_in`|`tab`| +|`sharing_level`|`owner`| +|`sharing_level`|`authenticated`| +|`sharing_level`|`organization`| +|`sharing_level`|`public`| +|`state`|`working`| +|`state`|`idle`| +|`state`|`complete`| +|`state`|`failure`| +|`lifecycle_state`|`created`| +|`lifecycle_state`|`starting`| +|`lifecycle_state`|`start_timeout`| +|`lifecycle_state`|`start_error`| +|`lifecycle_state`|`ready`| +|`lifecycle_state`|`shutting_down`| +|`lifecycle_state`|`shutdown_timeout`| +|`lifecycle_state`|`shutdown_error`| +|`lifecycle_state`|`off`| +|`startup_script_behavior`|`blocking`| +|`startup_script_behavior`|`non-blocking`| +|`status`|`connecting`| +|`status`|`connected`| +|`status`|`disconnected`| +|`status`|`timeout`| +|`workspace_transition`|`start`| +|`workspace_transition`|`stop`| +|`workspace_transition`|`delete`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2596,15 +2596,15 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------------------|---------------------|--------| -| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|101|[Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2)|Switching Protocols|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2637,10 +2637,10 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/ ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|----------------------------------------------------------------------------------|----------|--------------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | -| `body` | body | [codersdk.DynamicParametersRequest](schemas.md#codersdkdynamicparametersrequest) | true | Initial parameter values | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| +|`body`|body|[codersdk.DynamicParametersRequest](schemas.md#codersdkdynamicparametersrequest)|true|Initial parameter values| ### Example responses @@ -2722,9 +2722,9 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DynamicParametersResponse](schemas.md#codersdkdynamicparametersresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.DynamicParametersResponse](schemas.md#codersdkdynamicparametersresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2743,9 +2743,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/e ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -2767,24 +2767,24 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/e ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionExternalAuth](schemas.md#codersdktemplateversionexternalauth) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.TemplateVersionExternalAuth](schemas.md#codersdktemplateversionexternalauth)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------------|---------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» authenticate_url` | string | false | | | -| `» authenticated` | boolean | false | | | -| `» display_icon` | string | false | | | -| `» display_name` | string | false | | | -| `» id` | string | false | | | -| `» optional` | boolean | false | | | -| `» type` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» authenticate_url`|string|false||| +|`» authenticated`|boolean|false||| +|`» display_icon`|string|false||| +|`» display_name`|string|false||| +|`» id`|string|false||| +|`» optional`|boolean|false||| +|`» type`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2803,12 +2803,12 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/l ### Parameters -| Name | In | Type | Required | Description | -|-------------------|-------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | -| `before` | query | integer | false | Before log id | -| `after` | query | integer | false | After log id | -| `follow` | query | boolean | false | Follow log stream | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| +|`before`|query|integer|false|Before log id| +|`after`|query|integer|false|After log id| +|`follow`|query|boolean|false|Follow log stream| ### Example responses @@ -2829,35 +2829,35 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/l ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|----------------------------------------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | false | | | -| `» id` | integer | false | | | -| `» log_level` | [codersdk.LogLevel](schemas.md#codersdkloglevel) | false | | | -| `» log_source` | [codersdk.LogSource](schemas.md#codersdklogsource) | false | | | -| `» output` | string | false | | | -| `» stage` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|false||| +|`» id`|integer|false||| +|`» log_level`|[codersdk.LogLevel](schemas.md#codersdkloglevel)|false||| +|`» log_source`|[codersdk.LogSource](schemas.md#codersdklogsource)|false||| +|`» output`|string|false||| +|`» stage`|string|false||| #### Enumerated Values -| Property | Value | -|--------------|----------------------| -| `log_level` | `trace` | -| `log_level` | `debug` | -| `log_level` | `info` | -| `log_level` | `warn` | -| `log_level` | `error` | -| `log_source` | `provisioner_daemon` | -| `log_source` | `provisioner` | +|Property|Value| +|---|---| +|`log_level`|`trace`| +|`log_level`|`debug`| +|`log_level`|`info`| +|`log_level`|`warn`| +|`log_level`|`error`| +|`log_source`|`provisioner_daemon`| +|`log_source`|`provisioner`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2875,15 +2875,15 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/p ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2902,9 +2902,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/p ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -2931,9 +2931,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/p ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Preset](schemas.md#codersdkpreset) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Preset](schemas.md#codersdkpreset)|

Response Schema

@@ -2969,9 +2969,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -3118,153 +3118,153 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|---------------------------------|--------------------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» agents` | array | false | | | -| `»» api_version` | string | false | | | -| `»» apps` | array | false | | | -| `»»» command` | string | false | | | -| `»»» display_name` | string | false | | Display name is a friendly name for the app. | -| `»»» external` | boolean | false | | External specifies whether the URL should be opened externally on the client or not. | -| `»»» group` | string | false | | | -| `»»» health` | [codersdk.WorkspaceAppHealth](schemas.md#codersdkworkspaceapphealth) | false | | | -| `»»» healthcheck` | [codersdk.Healthcheck](schemas.md#codersdkhealthcheck) | false | | Healthcheck specifies the configuration for checking app health. | -| `»»»» interval` | integer | false | | Interval specifies the seconds between each health check. | -| `»»»» threshold` | integer | false | | Threshold specifies the number of consecutive failed health checks before returning "unhealthy". | -| `»»»» url` | string | false | | URL specifies the endpoint to check for the app health. | -| `»»» hidden` | boolean | false | | | -| `»»» icon` | string | false | | Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. | -| `»»» id` | string(uuid) | false | | | -| `»»» open_in` | [codersdk.WorkspaceAppOpenIn](schemas.md#codersdkworkspaceappopenin) | false | | | -| `»»» sharing_level` | [codersdk.WorkspaceAppSharingLevel](schemas.md#codersdkworkspaceappsharinglevel) | false | | | -| `»»» slug` | string | false | | Slug is a unique identifier within the agent. | -| `»»» statuses` | array | false | | Statuses is a list of statuses for the app. | -| `»»»» agent_id` | string(uuid) | false | | | -| `»»»» app_id` | string(uuid) | false | | | -| `»»»» created_at` | string(date-time) | false | | | -| `»»»» icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. | -| `»»»» id` | string(uuid) | false | | | -| `»»»» message` | string | false | | | -| `»»»» needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. | -| `»»»» state` | [codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate) | false | | | -| `»»»» uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file | -| `»»»» workspace_id` | string(uuid) | false | | | -| `»»» subdomain` | boolean | false | | Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI. | -| `»»» subdomain_name` | string | false | | Subdomain name is the application domain exposed on the `coder server`. | -| `»»» url` | string | false | | URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client. | -| `»» architecture` | string | false | | | -| `»» connection_timeout_seconds` | integer | false | | | -| `»» created_at` | string(date-time) | false | | | -| `»» directory` | string | false | | | -| `»» disconnected_at` | string(date-time) | false | | | -| `»» display_apps` | array | false | | | -| `»» environment_variables` | object | false | | | -| `»»» [any property]` | string | false | | | -| `»» expanded_directory` | string | false | | | -| `»» first_connected_at` | string(date-time) | false | | | -| `»» health` | [codersdk.WorkspaceAgentHealth](schemas.md#codersdkworkspaceagenthealth) | false | | Health reports the health of the agent. | -| `»»» healthy` | boolean | false | | Healthy is true if the agent is healthy. | -| `»»» reason` | string | false | | Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true. | -| `»» id` | string(uuid) | false | | | -| `»» instance_id` | string | false | | | -| `»» last_connected_at` | string(date-time) | false | | | -| `»» latency` | object | false | | Latency is mapped by region name (e.g. "New York City", "Seattle"). | -| `»»» [any property]` | [codersdk.DERPRegion](schemas.md#codersdkderpregion) | false | | | -| `»»»» latency_ms` | number | false | | | -| `»»»» preferred` | boolean | false | | | -| `»» lifecycle_state` | [codersdk.WorkspaceAgentLifecycle](schemas.md#codersdkworkspaceagentlifecycle) | false | | | -| `»» log_sources` | array | false | | | -| `»»» created_at` | string(date-time) | false | | | -| `»»» display_name` | string | false | | | -| `»»» icon` | string | false | | | -| `»»» id` | string(uuid) | false | | | -| `»»» workspace_agent_id` | string(uuid) | false | | | -| `»» logs_length` | integer | false | | | -| `»» logs_overflowed` | boolean | false | | | -| `»» name` | string | false | | | -| `»» operating_system` | string | false | | | -| `»» parent_id` | [uuid.NullUUID](schemas.md#uuidnulluuid) | false | | | -| `»»» uuid` | string | false | | | -| `»»» valid` | boolean | false | | Valid is true if UUID is not NULL | -| `»» ready_at` | string(date-time) | false | | | -| `»» resource_id` | string(uuid) | false | | | -| `»» scripts` | array | false | | | -| `»»» cron` | string | false | | | -| `»»» display_name` | string | false | | | -| `»»» id` | string(uuid) | false | | | -| `»»» log_path` | string | false | | | -| `»»» log_source_id` | string(uuid) | false | | | -| `»»» run_on_start` | boolean | false | | | -| `»»» run_on_stop` | boolean | false | | | -| `»»» script` | string | false | | | -| `»»» start_blocks_login` | boolean | false | | | -| `»»» timeout` | integer | false | | | -| `»» started_at` | string(date-time) | false | | | -| `»» startup_script_behavior` | [codersdk.WorkspaceAgentStartupScriptBehavior](schemas.md#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](schemas.md#codersdkworkspaceagentstatus) | false | | | -| `»» subsystems` | array | false | | | -| `»» troubleshooting_url` | string | false | | | -| `»» updated_at` | string(date-time) | false | | | -| `»» version` | string | false | | | -| `» created_at` | string(date-time) | false | | | -| `» daily_cost` | integer | false | | | -| `» hide` | boolean | false | | | -| `» icon` | string | false | | | -| `» id` | string(uuid) | false | | | -| `» job_id` | string(uuid) | false | | | -| `» metadata` | array | false | | | -| `»» key` | string | false | | | -| `»» sensitive` | boolean | false | | | -| `»» value` | string | false | | | -| `» name` | string | false | | | -| `» type` | string | false | | | -| `» workspace_transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» agents`|array|false||| +|`»» api_version`|string|false||| +|`»» apps`|array|false||| +|`»»» command`|string|false||| +|`»»» display_name`|string|false||Display name is a friendly name for the app.| +|`»»» external`|boolean|false||External specifies whether the URL should be opened externally on the client or not.| +|`»»» group`|string|false||| +|`»»» health`|[codersdk.WorkspaceAppHealth](schemas.md#codersdkworkspaceapphealth)|false||| +|`»»» healthcheck`|[codersdk.Healthcheck](schemas.md#codersdkhealthcheck)|false||Healthcheck specifies the configuration for checking app health.| +|`»»»» interval`|integer|false||Interval specifies the seconds between each health check.| +|`»»»» threshold`|integer|false||Threshold specifies the number of consecutive failed health checks before returning "unhealthy".| +|`»»»» url`|string|false||URL specifies the endpoint to check for the app health.| +|`»»» hidden`|boolean|false||| +|`»»» icon`|string|false||Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.| +|`»»» id`|string(uuid)|false||| +|`»»» open_in`|[codersdk.WorkspaceAppOpenIn](schemas.md#codersdkworkspaceappopenin)|false||| +|`»»» sharing_level`|[codersdk.WorkspaceAppSharingLevel](schemas.md#codersdkworkspaceappsharinglevel)|false||| +|`»»» slug`|string|false||Slug is a unique identifier within the agent.| +|`»»» statuses`|array|false||Statuses is a list of statuses for the app.| +|`»»»» agent_id`|string(uuid)|false||| +|`»»»» app_id`|string(uuid)|false||| +|`»»»» created_at`|string(date-time)|false||| +|`»»»» icon`|string|false||Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI.| +|`»»»» id`|string(uuid)|false||| +|`»»»» message`|string|false||| +|`»»»» needs_user_attention`|boolean|false||Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention.| +|`»»»» state`|[codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate)|false||| +|`»»»» uri`|string|false||Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file| +|`»»»» workspace_id`|string(uuid)|false||| +|`»»» subdomain`|boolean|false||Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.| +|`»»» subdomain_name`|string|false||Subdomain name is the application domain exposed on the `coder server`.| +|`»»» url`|string|false||URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.| +|`»» architecture`|string|false||| +|`»» connection_timeout_seconds`|integer|false||| +|`»» created_at`|string(date-time)|false||| +|`»» directory`|string|false||| +|`»» disconnected_at`|string(date-time)|false||| +|`»» display_apps`|array|false||| +|`»» environment_variables`|object|false||| +|`»»» [any property]`|string|false||| +|`»» expanded_directory`|string|false||| +|`»» first_connected_at`|string(date-time)|false||| +|`»» health`|[codersdk.WorkspaceAgentHealth](schemas.md#codersdkworkspaceagenthealth)|false||Health reports the health of the agent.| +|`»»» healthy`|boolean|false||Healthy is true if the agent is healthy.| +|`»»» reason`|string|false||Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.| +|`»» id`|string(uuid)|false||| +|`»» instance_id`|string|false||| +|`»» last_connected_at`|string(date-time)|false||| +|`»» latency`|object|false||Latency is mapped by region name (e.g. "New York City", "Seattle").| +|`»»» [any property]`|[codersdk.DERPRegion](schemas.md#codersdkderpregion)|false||| +|`»»»» latency_ms`|number|false||| +|`»»»» preferred`|boolean|false||| +|`»» lifecycle_state`|[codersdk.WorkspaceAgentLifecycle](schemas.md#codersdkworkspaceagentlifecycle)|false||| +|`»» log_sources`|array|false||| +|`»»» created_at`|string(date-time)|false||| +|`»»» display_name`|string|false||| +|`»»» icon`|string|false||| +|`»»» id`|string(uuid)|false||| +|`»»» workspace_agent_id`|string(uuid)|false||| +|`»» logs_length`|integer|false||| +|`»» logs_overflowed`|boolean|false||| +|`»» name`|string|false||| +|`»» operating_system`|string|false||| +|`»» parent_id`|[uuid.NullUUID](schemas.md#uuidnulluuid)|false||| +|`»»» uuid`|string|false||| +|`»»» valid`|boolean|false||Valid is true if UUID is not NULL| +|`»» ready_at`|string(date-time)|false||| +|`»» resource_id`|string(uuid)|false||| +|`»» scripts`|array|false||| +|`»»» cron`|string|false||| +|`»»» display_name`|string|false||| +|`»»» id`|string(uuid)|false||| +|`»»» log_path`|string|false||| +|`»»» log_source_id`|string(uuid)|false||| +|`»»» run_on_start`|boolean|false||| +|`»»» run_on_stop`|boolean|false||| +|`»»» script`|string|false||| +|`»»» start_blocks_login`|boolean|false||| +|`»»» timeout`|integer|false||| +|`»» started_at`|string(date-time)|false||| +|`»» startup_script_behavior`|[codersdk.WorkspaceAgentStartupScriptBehavior](schemas.md#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](schemas.md#codersdkworkspaceagentstatus)|false||| +|`»» subsystems`|array|false||| +|`»» troubleshooting_url`|string|false||| +|`»» updated_at`|string(date-time)|false||| +|`»» version`|string|false||| +|`» created_at`|string(date-time)|false||| +|`» daily_cost`|integer|false||| +|`» hide`|boolean|false||| +|`» icon`|string|false||| +|`» id`|string(uuid)|false||| +|`» job_id`|string(uuid)|false||| +|`» metadata`|array|false||| +|`»» key`|string|false||| +|`»» sensitive`|boolean|false||| +|`»» value`|string|false||| +|`» name`|string|false||| +|`» type`|string|false||| +|`» workspace_transition`|[codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition)|false||| #### Enumerated Values -| Property | Value | -|---------------------------|--------------------| -| `health` | `disabled` | -| `health` | `initializing` | -| `health` | `healthy` | -| `health` | `unhealthy` | -| `open_in` | `slim-window` | -| `open_in` | `tab` | -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | -| `state` | `working` | -| `state` | `idle` | -| `state` | `complete` | -| `state` | `failure` | -| `lifecycle_state` | `created` | -| `lifecycle_state` | `starting` | -| `lifecycle_state` | `start_timeout` | -| `lifecycle_state` | `start_error` | -| `lifecycle_state` | `ready` | -| `lifecycle_state` | `shutting_down` | -| `lifecycle_state` | `shutdown_timeout` | -| `lifecycle_state` | `shutdown_error` | -| `lifecycle_state` | `off` | -| `startup_script_behavior` | `blocking` | -| `startup_script_behavior` | `non-blocking` | -| `status` | `connecting` | -| `status` | `connected` | -| `status` | `disconnected` | -| `status` | `timeout` | -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | +|Property|Value| +|---|---| +|`health`|`disabled`| +|`health`|`initializing`| +|`health`|`healthy`| +|`health`|`unhealthy`| +|`open_in`|`slim-window`| +|`open_in`|`tab`| +|`sharing_level`|`owner`| +|`sharing_level`|`authenticated`| +|`sharing_level`|`organization`| +|`sharing_level`|`public`| +|`state`|`working`| +|`state`|`idle`| +|`state`|`complete`| +|`state`|`failure`| +|`lifecycle_state`|`created`| +|`lifecycle_state`|`starting`| +|`lifecycle_state`|`start_timeout`| +|`lifecycle_state`|`start_error`| +|`lifecycle_state`|`ready`| +|`lifecycle_state`|`shutting_down`| +|`lifecycle_state`|`shutdown_timeout`| +|`lifecycle_state`|`shutdown_error`| +|`lifecycle_state`|`off`| +|`startup_script_behavior`|`blocking`| +|`startup_script_behavior`|`non-blocking`| +|`status`|`connecting`| +|`status`|`connected`| +|`status`|`disconnected`| +|`status`|`timeout`| +|`workspace_transition`|`start`| +|`workspace_transition`|`stop`| +|`workspace_transition`|`delete`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3283,9 +3283,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -3324,60 +3324,60 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionParameter](schemas.md#codersdktemplateversionparameter) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.TemplateVersionParameter](schemas.md#codersdktemplateversionparameter)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|---------------------------|----------------------------------------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------| -| `[array item]` | array | false | | | -| `» default_value` | string | false | | | -| `» description` | string | false | | | -| `» description_plaintext` | string | false | | | -| `» display_name` | string | false | | | -| `» ephemeral` | boolean | false | | | -| `» form_type` | string | false | | Form type has an enum value of empty string, `""`. Keep the leading comma in the enums struct tag. | -| `» icon` | string | false | | | -| `» mutable` | boolean | false | | | -| `» name` | string | false | | | -| `» options` | array | false | | | -| `»» description` | string | false | | | -| `»» icon` | string | false | | | -| `»» name` | string | false | | | -| `»» value` | string | false | | | -| `» required` | boolean | false | | | -| `» type` | string | false | | | -| `» validation_error` | string | false | | | -| `» validation_max` | integer | false | | | -| `» validation_min` | integer | false | | | -| `» validation_monotonic` | [codersdk.ValidationMonotonicOrder](schemas.md#codersdkvalidationmonotonicorder) | false | | | -| `» validation_regex` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» default_value`|string|false||| +|`» description`|string|false||| +|`» description_plaintext`|string|false||| +|`» display_name`|string|false||| +|`» ephemeral`|boolean|false||| +|`» form_type`|string|false||Form type has an enum value of empty string, `""`. Keep the leading comma in the enums struct tag.| +|`» icon`|string|false||| +|`» mutable`|boolean|false||| +|`» name`|string|false||| +|`» options`|array|false||| +|`»» description`|string|false||| +|`»» icon`|string|false||| +|`»» name`|string|false||| +|`»» value`|string|false||| +|`» required`|boolean|false||| +|`» type`|string|false||| +|`» validation_error`|string|false||| +|`» validation_max`|integer|false||| +|`» validation_min`|integer|false||| +|`» validation_monotonic`|[codersdk.ValidationMonotonicOrder](schemas.md#codersdkvalidationmonotonicorder)|false||| +|`» validation_regex`|string|false||| #### Enumerated Values -| Property | Value | -|------------------------|----------------| -| `form_type` | `` | -| `form_type` | `radio` | -| `form_type` | `dropdown` | -| `form_type` | `input` | -| `form_type` | `textarea` | -| `form_type` | `slider` | -| `form_type` | `checkbox` | -| `form_type` | `switch` | -| `form_type` | `tag-select` | -| `form_type` | `multi-select` | -| `form_type` | `error` | -| `type` | `string` | -| `type` | `number` | -| `type` | `bool` | -| `type` | `list(string)` | -| `validation_monotonic` | `increasing` | -| `validation_monotonic` | `decreasing` | +|Property|Value| +|---|---| +|`form_type`|``| +|`form_type`|`radio`| +|`form_type`|`dropdown`| +|`form_type`|`input`| +|`form_type`|`textarea`| +|`form_type`|`slider`| +|`form_type`|`checkbox`| +|`form_type`|`switch`| +|`form_type`|`tag-select`| +|`form_type`|`multi-select`| +|`form_type`|`error`| +|`type`|`string`| +|`type`|`number`| +|`type`|`bool`| +|`type`|`list(string)`| +|`validation_monotonic`|`increasing`| +|`validation_monotonic`|`decreasing`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3395,15 +3395,15 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/s ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3422,9 +3422,9 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/ ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -3445,9 +3445,9 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3466,9 +3466,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/v ### Parameters -| Name | In | Type | Required | Description | -|-------------------|------|--------------|----------|---------------------| -| `templateversion` | path | string(uuid) | true | Template version ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`templateversion`|path|string(uuid)|true|Template version ID| ### Example responses @@ -3490,31 +3490,31 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/v ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionVariable](schemas.md#codersdktemplateversionvariable) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.TemplateVersionVariable](schemas.md#codersdktemplateversionvariable)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|-------------------|---------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» default_value` | string | false | | | -| `» description` | string | false | | | -| `» name` | string | false | | | -| `» required` | boolean | false | | | -| `» sensitive` | boolean | false | | | -| `» type` | string | false | | | -| `» value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» default_value`|string|false||| +|`» description`|string|false||| +|`» name`|string|false||| +|`» required`|boolean|false||| +|`» sensitive`|boolean|false||| +|`» type`|string|false||| +|`» value`|string|false||| #### Enumerated Values -| Property | Value | -|----------|----------| -| `type` | `string` | -| `type` | `number` | -| `type` | `bool` | +|Property|Value| +|---|---| +|`type`|`string`| +|`type`|`number`| +|`type`|`bool`| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/users.md b/docs/reference/api/users.md index 43842fde6539b..f41cf1e3aa666 100644 --- a/docs/reference/api/users.md +++ b/docs/reference/api/users.md @@ -15,12 +15,12 @@ curl -X GET http://coder-server:8080/api/v2/users \ ### Parameters -| Name | In | Type | Required | Description | -|------------|-------|--------------|----------|--------------| -| `q` | query | string | false | Search query | -| `after_id` | query | string(uuid) | false | After ID | -| `limit` | query | integer | false | Page limit | -| `offset` | query | integer | false | Page offset | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`q`|query|string|false|Search query| +|`after_id`|query|string(uuid)|false|After ID| +|`limit`|query|integer|false|Page limit| +|`offset`|query|integer|false|Page offset| ### Example responses @@ -59,9 +59,9 @@ curl -X GET http://coder-server:8080/api/v2/users \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GetUsersResponse](schemas.md#codersdkgetusersresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GetUsersResponse](schemas.md#codersdkgetusersresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -97,9 +97,9 @@ curl -X POST http://coder-server:8080/api/v2/users \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------------|----------|---------------------| -| `body` | body | [codersdk.CreateUserRequestWithOrgs](schemas.md#codersdkcreateuserrequestwithorgs) | true | Create user request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.CreateUserRequestWithOrgs](schemas.md#codersdkcreateuserrequestwithorgs)|true|Create user request| ### Example responses @@ -133,9 +133,9 @@ curl -X POST http://coder-server:8080/api/v2/users \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -176,9 +176,9 @@ curl -X GET http://coder-server:8080/api/v2/users/authmethods \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuthMethods](schemas.md#codersdkauthmethods) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.AuthMethods](schemas.md#codersdkauthmethods)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -214,9 +214,9 @@ curl -X GET http://coder-server:8080/api/v2/users/first \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -257,9 +257,9 @@ curl -X POST http://coder-server:8080/api/v2/users/first \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------|----------|--------------------| -| `body` | body | [codersdk.CreateFirstUserRequest](schemas.md#codersdkcreatefirstuserrequest) | true | First user request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`body`|body|[codersdk.CreateFirstUserRequest](schemas.md#codersdkcreatefirstuserrequest)|true|First user request| ### Example responses @@ -274,9 +274,9 @@ curl -X POST http://coder-server:8080/api/v2/users/first \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.CreateFirstUserResponse](schemas.md#codersdkcreatefirstuserresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.CreateFirstUserResponse](schemas.md#codersdkcreatefirstuserresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -312,9 +312,9 @@ curl -X POST http://coder-server:8080/api/v2/users/logout \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -332,9 +332,9 @@ curl -X GET http://coder-server:8080/api/v2/users/oauth2/github/callback \ ### Responses -| Status | Meaning | Description | Schema | -|--------|-------------------------------------------------------------------------|--------------------|--------| -| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|307|[Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7)|Temporary Redirect|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -367,9 +367,9 @@ curl -X GET http://coder-server:8080/api/v2/users/oauth2/github/device \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuthDevice](schemas.md#codersdkexternalauthdevice) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ExternalAuthDevice](schemas.md#codersdkexternalauthdevice)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -387,9 +387,9 @@ curl -X GET http://coder-server:8080/api/v2/users/oidc/callback \ ### Responses -| Status | Meaning | Description | Schema | -|--------|-------------------------------------------------------------------------|--------------------|--------| -| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|307|[Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7)|Temporary Redirect|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -408,9 +408,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user} \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|--------------------------| -| `user` | path | string | true | User ID, username, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, username, or me| ### Example responses @@ -444,9 +444,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -464,15 +464,15 @@ curl -X DELETE http://coder-server:8080/api/v2/users/{user} \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -491,9 +491,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/appearance \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -508,9 +508,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/appearance \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserAppearanceSettings](schemas.md#codersdkuserappearancesettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.UserAppearanceSettings](schemas.md#codersdkuserappearancesettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -539,10 +539,10 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/appearance \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------------------------------------------------------|----------|-------------------------| -| `user` | path | string | true | User ID, name, or me | -| `body` | body | [codersdk.UpdateUserAppearanceSettingsRequest](schemas.md#codersdkupdateuserappearancesettingsrequest) | true | New appearance settings | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`body`|body|[codersdk.UpdateUserAppearanceSettingsRequest](schemas.md#codersdkupdateuserappearancesettingsrequest)|true|New appearance settings| ### Example responses @@ -557,9 +557,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/appearance \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserAppearanceSettings](schemas.md#codersdkuserappearancesettings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.UserAppearanceSettings](schemas.md#codersdkuserappearancesettings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -578,10 +578,10 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/autofill-parameters?tem ### Parameters -| Name | In | Type | Required | Description | -|---------------|-------|--------|----------|--------------------------| -| `user` | path | string | true | User ID, username, or me | -| `template_id` | query | string | true | Template ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, username, or me| +|`template_id`|query|string|true|Template ID| ### Example responses @@ -598,19 +598,19 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/autofill-parameters?tem ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|---------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.UserParameter](schemas.md#codersdkuserparameter) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.UserParameter](schemas.md#codersdkuserparameter)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------|--------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» name` | string | false | | | -| `» value` | string | false | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» name`|string|false||| +|`» value`|string|false||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -629,9 +629,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/gitsshkey \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -648,9 +648,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/gitsshkey \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GitSSHKey](schemas.md#codersdkgitsshkey) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GitSSHKey](schemas.md#codersdkgitsshkey)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -669,9 +669,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/gitsshkey \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -688,9 +688,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/gitsshkey \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GitSSHKey](schemas.md#codersdkgitsshkey) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.GitSSHKey](schemas.md#codersdkgitsshkey)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -709,9 +709,9 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/keys \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -725,9 +725,9 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/keys \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.GenerateAPIKeyResponse](schemas.md#codersdkgenerateapikeyresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.GenerateAPIKeyResponse](schemas.md#codersdkgenerateapikeyresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -746,9 +746,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -773,38 +773,38 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.APIKey](schemas.md#codersdkapikey) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.APIKey](schemas.md#codersdkapikey)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|----------------------|--------------------------------------------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | true | | | -| `» expires_at` | string(date-time) | true | | | -| `» id` | string | true | | | -| `» last_used` | string(date-time) | true | | | -| `» lifetime_seconds` | integer | true | | | -| `» login_type` | [codersdk.LoginType](schemas.md#codersdklogintype) | true | | | -| `» scope` | [codersdk.APIKeyScope](schemas.md#codersdkapikeyscope) | true | | | -| `» token_name` | string | true | | | -| `» updated_at` | string(date-time) | true | | | -| `» user_id` | string(uuid) | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|true||| +|`» expires_at`|string(date-time)|true||| +|`» id`|string|true||| +|`» last_used`|string(date-time)|true||| +|`» lifetime_seconds`|integer|true||| +|`» login_type`|[codersdk.LoginType](schemas.md#codersdklogintype)|true||| +|`» scope`|[codersdk.APIKeyScope](schemas.md#codersdkapikeyscope)|true||| +|`» token_name`|string|true||| +|`» updated_at`|string(date-time)|true||| +|`» user_id`|string(uuid)|true||| #### Enumerated Values -| Property | Value | -|--------------|-----------------------| -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `scope` | `all` | -| `scope` | `application_connect` | +|Property|Value| +|---|---| +|`login_type`|`password`| +|`login_type`|`github`| +|`login_type`|`oidc`| +|`login_type`|`token`| +|`scope`|`all`| +|`scope`|`application_connect`| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -834,10 +834,10 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/keys/tokens \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `body` | body | [codersdk.CreateTokenRequest](schemas.md#codersdkcreatetokenrequest) | true | Create token request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`body`|body|[codersdk.CreateTokenRequest](schemas.md#codersdkcreatetokenrequest)|true|Create token request| ### Example responses @@ -851,9 +851,9 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/keys/tokens \ ### Responses -| Status | Meaning | Description | Schema | -|--------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------| -| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.GenerateAPIKeyResponse](schemas.md#codersdkgenerateapikeyresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[codersdk.GenerateAPIKeyResponse](schemas.md#codersdkgenerateapikeyresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -872,10 +872,10 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/{keyname} \ ### Parameters -| Name | In | Type | Required | Description | -|-----------|------|----------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `keyname` | path | string(string) | true | Key Name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`keyname`|path|string(string)|true|Key Name| ### Example responses @@ -898,9 +898,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/{keyname} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.APIKey](schemas.md#codersdkapikey) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.APIKey](schemas.md#codersdkapikey)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -919,10 +919,10 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/{keyid} \ ### Parameters -| Name | In | Type | Required | Description | -|---------|------|--------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `keyid` | path | string(uuid) | true | Key ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`keyid`|path|string(uuid)|true|Key ID| ### Example responses @@ -945,9 +945,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/{keyid} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.APIKey](schemas.md#codersdkapikey) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.APIKey](schemas.md#codersdkapikey)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -965,16 +965,16 @@ curl -X DELETE http://coder-server:8080/api/v2/users/{user}/keys/{keyid} \ ### Parameters -| Name | In | Type | Required | Description | -|---------|------|--------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `keyid` | path | string(uuid) | true | Key ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`keyid`|path|string(uuid)|true|Key ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -993,9 +993,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/login-type \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -1009,9 +1009,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/login-type \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserLoginType](schemas.md#codersdkuserlogintype) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.UserLoginType](schemas.md#codersdkuserlogintype)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1030,9 +1030,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -1055,25 +1055,25 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Organization](schemas.md#codersdkorganization) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|array of [codersdk.Organization](schemas.md#codersdkorganization)|

Response Schema

Status Code **200** -| Name | Type | Required | Restrictions | Description | -|------------------|-------------------|----------|--------------|-------------| -| `[array item]` | array | false | | | -| `» created_at` | string(date-time) | true | | | -| `» description` | string | false | | | -| `» display_name` | string | false | | | -| `» icon` | string | false | | | -| `» id` | string(uuid) | true | | | -| `» is_default` | boolean | true | | | -| `» name` | string | false | | | -| `» updated_at` | string(date-time) | true | | | +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|`[array item]`|array|false||| +|`» created_at`|string(date-time)|true||| +|`» description`|string|false||| +|`» display_name`|string|false||| +|`» icon`|string|false||| +|`» id`|string(uuid)|true||| +|`» is_default`|boolean|true||| +|`» name`|string|false||| +|`» updated_at`|string(date-time)|true||| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1092,10 +1092,10 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations/{organiza ### Parameters -| Name | In | Type | Required | Description | -|--------------------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `organizationname` | path | string | true | Organization name | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`organizationname`|path|string|true|Organization name| ### Example responses @@ -1116,9 +1116,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations/{organiza ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Organization](schemas.md#codersdkorganization)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1146,16 +1146,16 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/password \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------------|----------|-------------------------| -| `user` | path | string | true | User ID, name, or me | -| `body` | body | [codersdk.UpdateUserPasswordRequest](schemas.md#codersdkupdateuserpasswordrequest) | true | Update password request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`body`|body|[codersdk.UpdateUserPasswordRequest](schemas.md#codersdkupdateuserpasswordrequest)|true|Update password request| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1184,10 +1184,10 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/profile \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|----------------------------------------------------------------------------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `body` | body | [codersdk.UpdateUserProfileRequest](schemas.md#codersdkupdateuserprofilerequest) | true | Updated profile | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`body`|body|[codersdk.UpdateUserProfileRequest](schemas.md#codersdkupdateuserprofilerequest)|true|Updated profile| ### Example responses @@ -1221,9 +1221,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/profile \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1242,9 +1242,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/roles \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -1278,9 +1278,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/roles \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1310,10 +1310,10 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/roles \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------------------------------------------------------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | -| `body` | body | [codersdk.UpdateRoles](schemas.md#codersdkupdateroles) | true | Update roles request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`body`|body|[codersdk.UpdateRoles](schemas.md#codersdkupdateroles)|true|Update roles request| ### Example responses @@ -1347,9 +1347,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/roles \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1368,9 +1368,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/activate \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -1404,9 +1404,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/activate \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1425,9 +1425,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/suspend \ ### Parameters -| Name | In | Type | Required | Description | -|--------|------|--------|----------|----------------------| -| `user` | path | string | true | User ID, name, or me | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| ### Example responses @@ -1461,8 +1461,8 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/suspend \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.User](schemas.md#codersdkuser)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/workspaceproxies.md b/docs/reference/api/workspaceproxies.md index 72527b7e305e4..f89d93ba488af 100644 --- a/docs/reference/api/workspaceproxies.md +++ b/docs/reference/api/workspaceproxies.md @@ -35,8 +35,8 @@ curl -X GET http://coder-server:8080/api/v2/regions \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.RegionsResponse-codersdk_Region](schemas.md#codersdkregionsresponse-codersdk_region) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.RegionsResponse-codersdk_Region](schemas.md#codersdkregionsresponse-codersdk_region)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/workspaces.md b/docs/reference/api/workspaces.md index debcb421e02e3..f1513c3fa034c 100644 --- a/docs/reference/api/workspaces.md +++ b/docs/reference/api/workspaces.md @@ -41,11 +41,11 @@ of the template will be used. ### Parameters -| Name | In | Type | Required | Description | -|----------------|------|------------------------------------------------------------------------------|----------|--------------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `user` | path | string | true | Username, UUID, or me | -| `body` | body | [codersdk.CreateWorkspaceRequest](schemas.md#codersdkcreateworkspacerequest) | true | Create workspace request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`organization`|path|string(uuid)|true|Organization ID| +|`user`|path|string|true|Username, UUID, or me| +|`body`|body|[codersdk.CreateWorkspaceRequest](schemas.md#codersdkcreateworkspacerequest)|true|Create workspace request| ### Example responses @@ -307,9 +307,9 @@ of the template will be used. ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Workspace](schemas.md#codersdkworkspace)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -328,11 +328,11 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam ### Parameters -| Name | In | Type | Required | Description | -|-------------------|-------|---------|----------|-------------------------------------------------------------| -| `user` | path | string | true | User ID, name, or me | -| `workspacename` | path | string | true | Workspace name | -| `include_deleted` | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|User ID, name, or me| +|`workspacename`|path|string|true|Workspace name| +|`include_deleted`|query|boolean|false|Return data instead of HTTP 404 if the workspace is deleted| ### Example responses @@ -594,9 +594,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Workspace](schemas.md#codersdkworkspace)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -641,10 +641,10 @@ of the template will be used. ### Parameters -| Name | In | Type | Required | Description | -|--------|------|------------------------------------------------------------------------------|----------|--------------------------| -| `user` | path | string | true | Username, UUID, or me | -| `body` | body | [codersdk.CreateWorkspaceRequest](schemas.md#codersdkcreateworkspacerequest) | true | Create workspace request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`user`|path|string|true|Username, UUID, or me| +|`body`|body|[codersdk.CreateWorkspaceRequest](schemas.md#codersdkcreateworkspacerequest)|true|Create workspace request| ### Example responses @@ -906,9 +906,9 @@ of the template will be used. ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Workspace](schemas.md#codersdkworkspace)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -927,11 +927,11 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \ ### Parameters -| Name | In | Type | Required | Description | -|----------|-------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `q` | query | string | false | Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, dormant, last_used_after, last_used_before, has-ai-task. | -| `limit` | query | integer | false | Page limit | -| `offset` | query | integer | false | Page offset | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`q`|query|string|false|Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, dormant, last_used_after, last_used_before, has-ai-task.| +|`limit`|query|integer|false|Page limit| +|`offset`|query|integer|false|Page offset| ### Example responses @@ -1181,9 +1181,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspacesResponse](schemas.md#codersdkworkspacesresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspacesResponse](schemas.md#codersdkworkspacesresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1202,10 +1202,10 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \ ### Parameters -| Name | In | Type | Required | Description | -|-------------------|-------|--------------|----------|-------------------------------------------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `include_deleted` | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`include_deleted`|query|boolean|false|Return data instead of HTTP 404 if the workspace is deleted| ### Example responses @@ -1467,9 +1467,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Workspace](schemas.md#codersdkworkspace)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1496,16 +1496,16 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaces/{workspace} \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|------------------------------------------------------------------------------|----------|-------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.UpdateWorkspaceRequest](schemas.md#codersdkupdateworkspacerequest) | true | Metadata update request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.UpdateWorkspaceRequest](schemas.md#codersdkupdateworkspacerequest)|true|Metadata update request| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1532,16 +1532,16 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/autostart \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|------------------------------------------------------------------------------------------------|----------|-------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.UpdateWorkspaceAutostartRequest](schemas.md#codersdkupdateworkspaceautostartrequest) | true | Schedule update request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.UpdateWorkspaceAutostartRequest](schemas.md#codersdkupdateworkspaceautostartrequest)|true|Schedule update request| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1568,16 +1568,16 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/autoupdates \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------------------------------------------------------------------------------------------------------|----------|---------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.UpdateWorkspaceAutomaticUpdatesRequest](schemas.md#codersdkupdateworkspaceautomaticupdatesrequest) | true | Automatic updates request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.UpdateWorkspaceAutomaticUpdatesRequest](schemas.md#codersdkupdateworkspaceautomaticupdatesrequest)|true|Automatic updates request| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1605,10 +1605,10 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------------------------------------------------------------------------|----------|------------------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.UpdateWorkspaceDormancy](schemas.md#codersdkupdateworkspacedormancy) | true | Make a workspace dormant or active | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.UpdateWorkspaceDormancy](schemas.md#codersdkupdateworkspacedormancy)|true|Make a workspace dormant or active| ### Example responses @@ -1870,9 +1870,9 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Workspace](schemas.md#codersdkworkspace)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1900,10 +1900,10 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/extend \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|------------------------------------------------------------------------------------|----------|--------------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.PutExtendWorkspaceRequest](schemas.md#codersdkputextendworkspacerequest) | true | Extend deadline update request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.PutExtendWorkspaceRequest](schemas.md#codersdkputextendworkspacerequest)|true|Extend deadline update request| ### Example responses @@ -1924,9 +1924,9 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/extend \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1944,15 +1944,15 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/favorite \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------|----------|--------------| -| `workspace` | path | string(uuid) | true | Workspace ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1970,15 +1970,15 @@ curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/favorite \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------|----------|--------------| -| `workspace` | path | string(uuid) | true | Workspace ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1997,9 +1997,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/resolve-autos ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------|----------|--------------| -| `workspace` | path | string(uuid) | true | Workspace ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| ### Example responses @@ -2013,9 +2013,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/resolve-autos ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ResolveAutostartResponse](schemas.md#codersdkresolveautostartresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ResolveAutostartResponse](schemas.md#codersdkresolveautostartresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2034,9 +2034,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/timings \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------|----------|--------------| -| `workspace` | path | string(uuid) | true | Workspace ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| ### Example responses @@ -2081,9 +2081,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/timings \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuildTimings](schemas.md#codersdkworkspacebuildtimings) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.WorkspaceBuildTimings](schemas.md#codersdkworkspacebuildtimings)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2110,16 +2110,16 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/ttl \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|------------------------------------------------------------------------------------|----------|------------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.UpdateWorkspaceTTLRequest](schemas.md#codersdkupdateworkspacettlrequest) | true | Workspace TTL update request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.UpdateWorkspaceTTLRequest](schemas.md#codersdkupdateworkspacettlrequest)|true|Workspace TTL update request| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2147,16 +2147,16 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/usage \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|------------------------------------------------------------------------------------|----------|------------------------------| -| `workspace` | path | string(uuid) | true | Workspace ID | -| `body` | body | [codersdk.PostWorkspaceUsageRequest](schemas.md#codersdkpostworkspaceusagerequest) | false | Post workspace usage request | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| +|`body`|body|[codersdk.PostWorkspaceUsageRequest](schemas.md#codersdkpostworkspaceusagerequest)|false|Post workspace usage request| ### Responses -| Status | Meaning | Description | Schema | -|--------|-----------------------------------------------------------------|-------------|--------| -| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2175,9 +2175,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------|----------|--------------| -| `workspace` | path | string(uuid) | true | Workspace ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| ### Example responses @@ -2185,9 +2185,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.Response](schemas.md#codersdkresponse)| To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2206,9 +2206,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch-ws \ ### Parameters -| Name | In | Type | Required | Description | -|-------------|------|--------------|----------|--------------| -| `workspace` | path | string(uuid) | true | Workspace ID | +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|`workspace`|path|string(uuid)|true|Workspace ID| ### Example responses @@ -2223,8 +2223,8 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch-ws \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ServerSentEvent](schemas.md#codersdkserversentevent) | +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[codersdk.ServerSentEvent](schemas.md#codersdkserversentevent)| To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/cli/builds.md b/docs/reference/cli/builds.md new file mode 100644 index 0000000000000..528a8f5ae36da --- /dev/null +++ b/docs/reference/cli/builds.md @@ -0,0 +1,16 @@ + +# builds + +Manage workspace builds + +## Usage + +```console +coder builds +``` + +## Subcommands + +| Name | Purpose | +|---------------------------------------|-----------------------------| +| [list](./builds_list.md) | List builds for a workspace | diff --git a/docs/reference/cli/builds_list.md b/docs/reference/cli/builds_list.md new file mode 100644 index 0000000000000..f31241d6af5b6 --- /dev/null +++ b/docs/reference/cli/builds_list.md @@ -0,0 +1,34 @@ + +# builds list + +List builds for a workspace + +Aliases: + +* ls + +## Usage + +```console +coder builds list [flags] +``` + +## Options + +### -c, --column + +| | | +|---------|-------------------------------------------------------------------| +| Type | [build\|build id\|status\|reason\|created\|duration] | +| Default | build,build id,status,reason,created,duration | + +Columns to display in table output. + +### -o, --output + +| | | +|---------|--------------------------| +| Type | table\|json | +| Default | table | + +Output format. diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md index 1992e5d6e9ac3..057cef988edb6 100644 --- a/docs/reference/cli/index.md +++ b/docs/reference/cli/index.md @@ -41,11 +41,13 @@ Coder — A tool for provisioning self-hosted development environments with Terr | [users](./users.md) | Manage users | | [version](./version.md) | Show coder version | | [autoupdate](./autoupdate.md) | Toggle auto-update policy for a workspace | +| [builds](./builds.md) | Manage workspace builds | | [config-ssh](./config-ssh.md) | Add an SSH Host entry for your workspaces "ssh workspace.coder" | | [create](./create.md) | Create a workspace | | [delete](./delete.md) | Delete a workspace | | [favorite](./favorite.md) | Add a workspace to your favorites | | [list](./list.md) | List workspaces | +| [logs](./logs.md) | Show logs for a workspace build | | [open](./open.md) | Open a workspace | | [ping](./ping.md) | Ping a workspace | | [rename](./rename.md) | Rename a workspace | diff --git a/docs/reference/cli/logs.md b/docs/reference/cli/logs.md new file mode 100644 index 0000000000000..7cb6576c55cb6 --- /dev/null +++ b/docs/reference/cli/logs.md @@ -0,0 +1,20 @@ + +# logs + +Show logs for a workspace build + +## Usage + +```console +coder logs [flags] +``` + +## Options + +### -f, --follow + +| | | +|------|-------------------| +| Type | bool | + +Follow log output (stream real-time logs).