Files

 f3d5166

/

docs.go

Copy path

Blame

Blame

Latest commit

 

History

History

3815 lines (3811 loc) · 131 KB

/

docs.go

Top

File metadata and controls

• Code
• Blame

3815 lines (3811 loc) · 131 KB

Raw

// Package apidoc GENERATED BY SWAG; DO NOT EDIT // This file was generated by swaggo/swag package apidoc import "github.com/swaggo/swag" const docTemplate = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "termsOfService": "https://coder.com/legal/terms-of-service", "contact": { "name": "API Support", "url": "https://coder.com", "email": "support@coder.com" }, "license": { "name": "AGPL-3.0", "url": "https://github.com/coder/coder/blob/main/LICENSE" }, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/": { "get": { "produces": [ "application/json" ], "tags": [ "General" ], "summary": "API root handler", "operationId": "api-root-handler", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Response" } } } } }, "/applications/auth-redirect": { "get": { "security": [ { "CoderSessionToken": [] } ], "tags": [ "Applications" ], "summary": "Redirect to URI with encrypted API key", "operationId": "redirect-to-uri-with-encrypted-api-key", "parameters": [ { "type": "string", "description": "Redirect destination", "name": "redirect_uri", "in": "query" } ], "responses": { "307": { "description": "Temporary Redirect" } } } }, "/applications/host": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Applications" ], "summary": "Get applications host", "operationId": "get-app-host", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.GetAppHostResponse" } } } } }, "/audit": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Audit" ], "summary": "Get audit logs", "operationId": "get-audit-logs", "parameters": [ { "type": "string", "description": "Search query", "name": "q", "in": "query", "required": true }, { "type": "string", "format": "uuid", "description": "After ID", "name": "after_id", "in": "query" }, { "type": "integer", "description": "Page limit", "name": "limit", "in": "query" }, { "type": "integer", "description": "Page offset", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.AuditLogResponse" } } } } }, "/audit/testgenerate": { "post": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "tags": [ "Audit" ], "summary": "Generate fake audit log", "operationId": "generate-fake-audit-logs", "parameters": [ { "description": "Audit log request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.CreateTestAuditLogRequest" } } ], "responses": { "204": { "description": "No Content" } } } }, "/authcheck": { "post": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authorization" ], "summary": "Check authorization", "operationId": "check-authorization", "parameters": [ { "description": "Authorization request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.AuthorizationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.AuthorizationResponse" } } } } }, "/buildinfo": { "get": { "produces": [ "application/json" ], "tags": [ "General" ], "summary": "Build info", "operationId": "build-info", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.BuildInfoResponse" } } } } }, "/config/deployment": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "General" ], "summary": "Get deployment config", "operationId": "get-deployment-config", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.DeploymentConfig" } } } } }, "/csp/reports": { "post": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "text/plain" ], "tags": [ "General" ], "summary": "Report CSP violations", "operationId": "report-csp-violations", "parameters": [ { "description": "Violation report", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/coderd.cspViolation" } } ], "responses": { "200": { "description": "OK" } } } }, "/files": { "post": { "security": [ { "CoderSessionToken": [] } ], "description": "Swagger notice: Swagger 2.0 doesn't support file upload with a ` + "`" + `content-type` + "`" + ` different than ` + "`" + `application/x-www-form-urlencoded` + "`" + `.", "consumes": [ "application/x-tar" ], "produces": [ "application/json" ], "tags": [ "Files" ], "summary": "Upload file", "operationId": "update-file", "parameters": [ { "type": "string", "default": "application/x-tar", "description": "Content-Type must be ` + "`" + `application/x-tar` + "`" + `", "name": "Content-Type", "in": "header", "required": true }, { "type": "file", "description": "File to be uploaded", "name": "file", "in": "formData", "required": true } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/codersdk.UploadResponse" } } } } }, "/files/{fileID}": { "get": { "security": [ { "CoderSessionToken": [] } ], "tags": [ "Files" ], "summary": "Get file by ID", "operationId": "get-file-by-id", "parameters": [ { "type": "string", "format": "uuid", "description": "File ID", "name": "fileID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/organizations/{organization-id}/templates/": { "post": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Templates" ], "summary": "Create template by organization", "operationId": "create-template-by-organization", "parameters": [ { "description": "Request body", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.CreateTemplateRequest" } }, { "type": "string", "description": "Organization ID", "name": "organization-id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Template" } } } } }, "/organizations/{organization}/members/{user}/workspaces": { "post": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Create workspace by organization", "operationId": "create-workspace-by-organization", "parameters": [ { "type": "string", "format": "uuid", "description": "Organization ID", "name": "organization", "in": "path", "required": true }, { "type": "string", "description": "Username", "name": "user", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Workspace" } } } } }, "/organizations/{organization}/templates": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Templates" ], "summary": "Get templates by organization", "operationId": "get-templates-by-organization", "parameters": [ { "type": "string", "format": "uuid", "description": "Organization ID", "name": "organization", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/codersdk.Template" } } } } } }, "/organizations/{organization}/templates/{template-name}": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Templates" ], "summary": "Get templates by organization and template name", "operationId": "get-templates-by-organization-and-template-name", "parameters": [ { "type": "string", "format": "uuid", "description": "Organization ID", "name": "organization", "in": "path", "required": true }, { "type": "string", "description": "Template name", "name": "template-name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Template" } } } } }, "/parameters/{scope}/{id}": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Parameters" ], "summary": "Get parameters", "operationId": "get-parameters", "parameters": [ { "enum": [ "template", "workspace", "import_job" ], "type": "string", "description": "Scope", "name": "scope", "in": "path", "required": true }, { "type": "string", "format": "uuid", "description": "ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/codersdk.Parameter" } } } } }, "post": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Parameters" ], "summary": "Create parameter", "operationId": "create-parameter", "parameters": [ { "description": "Parameter request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.CreateParameterRequest" } }, { "enum": [ "template", "workspace", "import_job" ], "type": "string", "description": "Scope", "name": "scope", "in": "path", "required": true }, { "type": "string", "format": "uuid", "description": "ID", "name": "id", "in": "path", "required": true } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/codersdk.Parameter" } } } } }, "/parameters/{scope}/{id}/{name}": { "delete": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Parameters" ], "summary": "Delete parameter", "operationId": "delete-parameter", "parameters": [ { "enum": [ "template", "workspace", "import_job" ], "type": "string", "description": "Scope", "name": "scope", "in": "path", "required": true }, { "type": "string", "format": "uuid", "description": "ID", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "Name", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Response" } } } } }, "/templates/{id}": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Templates" ], "summary": "Get template metadata by ID", "operationId": "get-template-metadata-by-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Template ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Template" } } } }, "delete": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Templates" ], "summary": "Delete template by ID", "operationId": "delete-template-by-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Template ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Response" } } } }, "patch": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Templates" ], "summary": "Update template metadata by ID", "operationId": "update-template-metadata", "parameters": [ { "type": "string", "format": "uuid", "description": "Template ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Template" } } } } }, "/updatecheck": { "get": { "produces": [ "application/json" ], "tags": [ "General" ], "summary": "Update check", "operationId": "update-check", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.UpdateCheckResponse" } } } } }, "/users/{user}/workspace/{workspacename}": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Get workspace metadata by owner and workspace name", "operationId": "get-workspace-metadata-by-owner-and-workspace-name", "parameters": [ { "type": "string", "description": "Owner username", "name": "user", "in": "path", "required": true }, { "type": "string", "description": "Workspace name", "name": "workspacename", "in": "path", "required": true }, { "type": "boolean", "description": "Return data instead of HTTP 404 if the workspace is deleted", "name": "include_deleted", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Workspace" } } } } }, "/workspaceagents/aws-instance-identity": { "post": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Authenticate agent on AWS instance", "operationId": "authenticate-agent-on-aws-instance", "parameters": [ { "description": "Instance identity token", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.AWSInstanceIdentityToken" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspaceAgentAuthenticateResponse" } } } } }, "/workspaceagents/azure-instance-identity": { "post": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Authenticate agent on Azure instance", "operationId": "authenticate-agent-on-azure-instance", "parameters": [ { "description": "Instance identity token", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.AzureInstanceIdentityToken" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspaceAgentAuthenticateResponse" } } } } }, "/workspaceagents/google-instance-identity": { "post": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Authenticate agent on Google Cloud instance", "operationId": "authenticate-agent-on-google-cloud-instance", "parameters": [ { "description": "Instance identity token", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.GoogleInstanceIdentityToken" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspaceAgentAuthenticateResponse" } } } } }, "/workspaceagents/me/app-health": { "post": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Submit workspace application health", "operationId": "submit-workspace-workspace-agent-health", "parameters": [ { "description": "Application health request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.PostWorkspaceAppHealthsRequest" } } ], "responses": { "200": { "description": "OK" } } } }, "/workspaceagents/me/coordinate": { "get": { "security": [ { "CoderSessionToken": [] } ], "description": "It accepts a WebSocket connection to an agent that listens to\nincoming connections and publishes node updates.", "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Coordinate workspace agent via Tailnet", "operationId": "get-workspace-agent-git-ssh-key-via-tailnet", "responses": { "101": { "description": "Switching Protocols" } } } }, "/workspaceagents/me/gitauth": { "get": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Get workspace agent Git auth", "operationId": "get-workspace-agent-git-auth", "parameters": [ { "type": "string", "format": "uri", "description": "Git URL", "name": "url", "in": "query", "required": true }, { "type": "boolean", "description": "Wait for a new token to be issued", "name": "listen", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspaceAgentGitAuthResponse" } } } } }, "/workspaceagents/me/gitsshkey": { "get": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Get workspace agent Git SSH key", "operationId": "get-workspace-agent-git-ssh-key", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.AgentGitSSHKey" } } } } }, "/workspaceagents/me/metadata": { "get": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Get authorized workspace agent metadata", "operationId": "get-authorized-workspace-agent-metadata", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspaceAgentMetadata" } } } } }, "/workspaceagents/me/report-stats": { "post": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Submit workspace agent stats", "operationId": "submit-workspace-workspace-agent-stats", "parameters": [ { "description": "Stats request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.AgentStats" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.AgentStatsResponse" } } } } }, "/workspaceagents/me/version": { "post": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Agents" ], "summary": "Submit workspace agent version", "operationId": "submit-workspace-workspace-agent-version", "parameters": [ { "description": "Version request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.PostWorkspaceAgentVersionRequest" } } ], "responses": { "200": { "description": "OK" } }, "x-apidocgen": { "skip": true } } }, "/workspacebuilds/{workspacebuild}": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Builds" ], "summary": "Get workspace build", "operationId": "get-workspace-build", "parameters": [ { "type": "string", "description": "Workspace build ID", "name": "workspacebuild", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspaceBuild" } } } } }, "/workspacebuilds/{workspacebuild}/cancel": { "patch": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Builds" ], "summary": "Cancel workspace build", "operationId": "cancel-workspace-build", "parameters": [ { "type": "string", "description": "Workspace build ID", "name": "workspacebuild", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Response" } } } } }, "/workspacebuilds/{workspacebuild}/logs": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Builds" ], "summary": "Get workspace build logs", "operationId": "get-workspace-build-logs", "parameters": [ { "type": "string", "description": "Workspace build ID", "name": "workspacebuild", "in": "path", "required": true }, { "type": "integer", "description": "Before Unix timestamp", "name": "before", "in": "query" }, { "type": "integer", "description": "After Unix timestamp", "name": "after", "in": "query" }, { "type": "boolean", "description": "Follow log stream", "name": "follow", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/codersdk.ProvisionerJobLog" } } } } } }, "/workspacebuilds/{workspacebuild}/resources": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Builds" ], "summary": "Get workspace resources for workspace build", "operationId": "get-workspace-resources-for-workspace-build", "parameters": [ { "type": "string", "description": "Workspace build ID", "name": "workspacebuild", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/codersdk.WorkspaceResource" } } } } } }, "/workspacebuilds/{workspacebuild}/state": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Builds" ], "summary": "Get provisioner state for workspace build", "operationId": "get-provisioner-state-for-workspace-build", "parameters": [ { "type": "string", "description": "Workspace build ID", "name": "workspacebuild", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspaceBuild" } } } } }, "/workspaces": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "List workspaces", "operationId": "get-workspaces", "parameters": [ { "type": "string", "description": "Filter by owner username", "name": "owner", "in": "query" }, { "type": "string", "description": "Filter by template name", "name": "template", "in": "query" }, { "type": "string", "description": "Filter with partial-match by workspace name", "name": "name", "in": "query" }, { "enum": [ "pending", "running", "stopping", "stopped", "failed", "canceling", "canceled", "deleted", "deleting" ], "type": "string", "description": "Filter by workspace status", "name": "status", "in": "query" }, { "enum": [ "connected", "connecting", "disconnected", "timeout" ], "type": "string", "description": "Filter by agent status", "name": "has_agent", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspacesResponse" } } } } }, "/workspaces/{id}": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Get workspace metadata by ID", "operationId": "get-workspace-metadata-by-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Workspace ID", "name": "id", "in": "path", "required": true }, { "type": "boolean", "description": "Return data instead of HTTP 404 if the workspace is deleted", "name": "include_deleted", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Workspace" } } } } }, "/workspaces/{id}/builds": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Builds" ], "summary": "Get workspace builds by workspace ID", "operationId": "get-workspace-builds-by-workspace-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Workspace ID", "name": "id", "in": "path", "required": true }, { "type": "string", "format": "uuid", "description": "After ID", "name": "after_id", "in": "query" }, { "type": "integer", "description": "Page limit", "name": "limit", "in": "query" }, { "type": "integer", "description": "Page offset", "name": "offset", "in": "query" }, { "type": "string", "format": "date-time", "description": "Since timestamp", "name": "since", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/codersdk.WorkspaceBuild" } } } } }, "post": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "application/json" ], "tags": [ "Builds" ], "summary": "Create workspace build", "operationId": "create-workspace-build", "parameters": [ { "type": "string", "format": "uuid", "description": "Workspace ID", "name": "id", "in": "path", "required": true }, { "description": "Create workspace build request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.CreateWorkspaceBuildRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.WorkspaceBuild" } } } } }, "/workspaces/{workspace}": { "patch": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Update workspace metadata by ID", "operationId": "update-workspace-metadata-by-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Workspace ID", "name": "workspace", "in": "path", "required": true }, { "description": "Metadata update request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.UpdateWorkspaceRequest" } } ], "responses": { "204": { "description": "No Content" } } } }, "/workspaces/{workspace}/autostart": { "put": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Update workspace autostart schedule by ID", "operationId": "update-workspace-autostart-schedule-by-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Workspace ID", "name": "workspace", "in": "path", "required": true }, { "description": "Schedule update request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.UpdateWorkspaceAutostartRequest" } } ], "responses": { "204": { "description": "No Content" } } } }, "/workspaces/{workspace}/extend": { "put": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Extend workspace deadline by ID", "operationId": "extend-workspace-deadline-by-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Workspace ID", "name": "workspace", "in": "path", "required": true }, { "description": "Extend deadline update request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.PutExtendWorkspaceRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Response" } } } } }, "/workspaces/{workspace}/ttl": { "put": { "security": [ { "CoderSessionToken": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Workspaces" ], "summary": "Update workspace TTL by ID", "operationId": "update-workspace-ttl-by-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Workspace ID", "name": "workspace", "in": "path", "required": true }, { "description": "Workspace TTL update request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/codersdk.UpdateWorkspaceTTLRequest" } } ], "responses": { "204": { "description": "No Content" } } } }, "/workspaces/{workspace}/watch": { "get": { "security": [ { "CoderSessionToken": [] } ], "produces": [ "text/event-stream" ], "tags": [ "Workspaces" ], "summary": "Watch workspace by ID", "operationId": "watch-workspace-id", "parameters": [ { "type": "string", "format": "uuid", "description": "Workspace ID", "name": "workspace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/codersdk.Response" } } } } } }, "definitions": { "coderd.cspViolation": { "type": "object", "properties": { "csp-report": { "type": "object", "additionalProperties": true } } }, "codersdk.AWSInstanceIdentityToken": { "type": "object", "required": [ "document", "signature" ], "properties": { "document": { "type": "string" }, "signature": { "type": "string" } } }, "codersdk.AgentGitSSHKey": { "type": "object", "properties": { "private_key": { "type": "string" }, "public_key": { "type": "string" } } }, "codersdk.AgentStats": { "type": "object", "properties": { "conns_by_proto": { "description": "ConnsByProto is a count of connections by protocol.", "type": "object", "additionalProperties": { "type": "integer" } }, "num_comms": { "description": "NumConns is the number of connections received by an agent.", "type": "integer" }, "rx_bytes": { "description": "RxBytes is the number of received bytes.", "type": "integer" }, "rx_packets": { "description": "RxPackets is the number of received packets.", "type": "integer" }, "tx_bytes": { "description": "TxBytes is the number of transmitted bytes.", "type": "integer" }, "tx_packets": { "description": "TxPackets is the number of transmitted bytes.", "type": "integer" } } }, "codersdk.AgentStatsResponse": { "type": "object", "properties": { "report_interval": { "description": "ReportInterval is the duration after which the agent should send stats\nagain.", "type": "integer" } } }, "codersdk.AuditDiff": { "type": "object", "additionalProperties": { "$ref": "#/definitions/codersdk.AuditDiffField" } }, "codersdk.AuditDiffField": { "type": "object", "properties": { "new": {}, "old": {}, "secret": { "type": "boolean" } } }, "codersdk.AuditLog": { "type": "object", "properties": { "action": { "type": "string" }, "additional_fields": { "type": "array", "items": { "type": "integer" } }, "description": { "type": "string" }, "diff": { "$ref": "#/definitions/codersdk.AuditDiff" }, "id": { "type": "string" }, "ip": { "$ref": "#/definitions/netip.Addr" }, "is_deleted": { "type": "boolean" }, "organization_id": { "type": "string" }, "request_id": { "type": "string" }, "resource_icon": { "type": "string" }, "resource_id": { "type": "string" }, "resource_link": { "type": "string" }, "resource_target": { "description": "ResourceTarget is the name of the resource.", "type": "string" }, "resource_type": { "type": "string" }, "status_code": { "type": "integer" }, "time": { "type": "string" }, "user": { "$ref": "#/definitions/codersdk.User" }, "user_agent": { "type": "string" } } }, "codersdk.AuditLogResponse": { "type": "object", "properties": { "audit_logs": { "type": "array", "items": { "$ref": "#/definitions/codersdk.AuditLog" } }, "count": { "type": "integer" } } }, "codersdk.AuthorizationCheck": { "description": "AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.", "type": "object", "properties": { "action": { "type": "string", "enum": [ "create", "read", "update", "delete" ] }, "object": { "description": "Object can represent a \"set\" of objects, such as:\n\t- All workspaces in an organization\n\t- All workspaces owned by me\n\t- All workspaces across the entire product\nWhen defining an object, use the most specific language when possible to\nproduce the smallest set. Meaning to set as many fields on 'Object' as\nyou can. Example, if you want to check if you can update all workspaces\nowned by 'me', try to also add an 'OrganizationID' to the settings.\nOmitting the 'OrganizationID' could produce the incorrect value, as\nworkspaces have both ` + "`" + `user` + "`" + ` and ` + "`" + `organization` + "`" + ` owners.", "$ref": "#/definitions/codersdk.AuthorizationObject" } } }, "codersdk.AuthorizationObject": { "description": "AuthorizationObject can represent a \"set\" of objects, such as: all workspaces in an organization, all workspaces owned by me, all workspaces across the entire product.", "type": "object", "properties": { "organization_id": { "description": "OrganizationID (optional) adds the set constraint to all resources owned by a given organization.", "type": "string" }, "owner_id": { "description": "OwnerID (optional) adds the set constraint to all resources owned by a given user.", "type": "string" }, "resource_id": { "description": "ResourceID (optional) reduces the set to a singular resource. This assigns\na resource ID to the resource type, eg: a single workspace.\nThe rbac library will not fetch the resource from the database, so if you\nare using this option, you should also set the owner ID and organization ID\nif possible. Be as specific as possible using all the fields relevant.", "type": "string" }, "resource_type": { "description": "ResourceType is the name of the resource.\n` + "`" + `./coderd/rbac/object.go` + "`" + ` has the list of valid resource types.", "type": "string" } } }, "codersdk.AuthorizationRequest": { "type": "object", "properties": { "checks": { "description": "Checks is a map keyed with an arbitrary string to a permission check.\nThe key can be any string that is helpful to the caller, and allows\nmultiple permission checks to be run in a single request.\nThe key ensures that each permission check has the same key in the\nresponse.", "type": "object", "additionalProperties": { "$ref": "#/definitions/codersdk.AuthorizationCheck" } } } }, "codersdk.AuthorizationResponse": { "type": "object", "additionalProperties": { "type": "boolean" } }, "codersdk.AzureInstanceIdentityToken": { "type": "object", "required": [ "encoding", "signature" ], "properties": { "encoding": { "type": "string" }, "signature": { "type": "string" } } }, "codersdk.BuildInfoResponse": { "type": "object", "properties": { "external_url": { "description": "ExternalURL references the current Coder version.\nFor production builds, this will link directly to a release. For development builds, this will link to a commit.", "type": "string" }, "version": { "description": "Version returns the semantic version of the build.", "type": "string" } } }, "codersdk.CreateParameterRequest": { "description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.", "type": "object", "required": [ "destination_scheme", "name", "source_scheme", "source_value" ], "properties": { "copy_from_parameter": { "description": "CloneID allows copying the value of another parameter.\nThe other param must be related to the same template_id for this to\nsucceed.\nNo other fields are required if using this, as all fields will be copied\nfrom the other parameter.", "type": "string" }, "destination_scheme": { "type": "string", "enum": [ "none", "environment_variable", "provisioner_variable" ] }, "name": { "type": "string" }, "source_scheme": { "type": "string", "enum": [ "none", "data" ] }, "source_value": { "type": "string" } } }, "codersdk.CreateTemplateRequest": { "type": "object", "required": [ "name", "template_version_id" ], "properties": { "allow_user_cancel_workspace_jobs": { "description": "Allow users to cancel in-progress workspace jobs.\n*bool as the default value is \"true\".", "type": "boolean" }, "default_ttl_ms": { "description": "DefaultTTLMillis allows optionally specifying the default TTL\nfor all workspaces created from this template.", "type": "integer" }, "description": { "description": "Description is a description of what the template contains. It must be\nless than 128 bytes.", "type": "string" }, "display_name": { "description": "DisplayName is the displayed name of the template.", "type": "string" }, "icon": { "description": "Icon is a relative path or external URL that specifies\nan icon to be displayed in the dashboard.", "type": "string" }, "name": { "description": "Name is the name of the template.", "type": "string" }, "parameter_values": { "type": "array", "items": { "$ref": "#/definitions/codersdk.CreateParameterRequest" } }, "template_version_id": { "description": "VersionID is an in-progress or completed job to use as an initial version\nof the template.\n\nThis is required on creation to enable a user-flow of validating a\ntemplate works. There is no reason the data-model cannot support empty\ntemplates, but it doesn't make sense for users.", "type": "string" } } }, "codersdk.CreateTestAuditLogRequest": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create", "write", "delete", "start", "stop" ] }, "resource_id": { "type": "string" }, "resource_type": { "type": "string", "enum": [ "organization", "template", "template_version", "user", "workspace", "workspace_build", "git_ssh_key", "api_key", "group" ] }, "time": { "type": "string" } } }, "codersdk.CreateWorkspaceBuildRequest": { "type": "object", "required": [ "transition" ], "properties": { "dry_run": { "type": "boolean" }, "orphan": { "description": "Orphan may be set for the Destroy transition.", "type": "boolean" }, "parameter_values": { "description": "ParameterValues are optional. It will write params to the 'workspace' scope.\nThis will overwrite any existing parameters with the same name.\nThis will not delete old params not included in this list.", "type": "array", "items": { "$ref": "#/definitions/codersdk.CreateParameterRequest" } }, "state": { "type": "array", "items": { "type": "integer" } }, "template_version_id": { "type": "string" }, "transition": { "type": "string", "enum": [ "create", "start", "stop", "delete" ] } } }, "codersdk.DERP": { "type": "object", "properties": { "config": { "$ref": "#/definitions/codersdk.DERPConfig" }, "server": { "$ref": "#/definitions/codersdk.DERPServerConfig" } } }, "codersdk.DERPConfig": { "type": "object", "properties": { "path": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" } } }, "codersdk.DERPRegion": { "type": "object", "properties": { "latency_ms": { "type": "number" }, "preferred": { "type": "boolean" } } }, "codersdk.DERPServerConfig": { "type": "object", "properties": { "enable": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "region_code": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "region_id": { "$ref": "#/definitions/codersdk.DeploymentConfigField-int" }, "region_name": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "relay_url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "stun_addresses": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" } } }, "codersdk.DeploymentConfig": { "type": "object", "properties": { "access_url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "address": { "description": "DEPRECATED: Use HTTPAddress or TLS.Address instead.", "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "agent_fallback_troubleshooting_url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "agent_stat_refresh_interval": { "$ref": "#/definitions/codersdk.DeploymentConfigField-time_Duration" }, "audit_logging": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "autobuild_poll_interval": { "$ref": "#/definitions/codersdk.DeploymentConfigField-time_Duration" }, "browser_only": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "cache_directory": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "derp": { "$ref": "#/definitions/codersdk.DERP" }, "experimental": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "gitauth": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_codersdk_GitAuthConfig" }, "http_address": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "in_memory_database": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "max_token_lifetime": { "$ref": "#/definitions/codersdk.DeploymentConfigField-time_Duration" }, "metrics_cache_refresh_interval": { "$ref": "#/definitions/codersdk.DeploymentConfigField-time_Duration" }, "oauth2": { "$ref": "#/definitions/codersdk.OAuth2Config" }, "oidc": { "$ref": "#/definitions/codersdk.OIDCConfig" }, "pg_connection_url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "pprof": { "$ref": "#/definitions/codersdk.PprofConfig" }, "prometheus": { "$ref": "#/definitions/codersdk.PrometheusConfig" }, "provisioner": { "$ref": "#/definitions/codersdk.ProvisionerConfig" }, "proxy_trusted_headers": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" }, "proxy_trusted_origins": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" }, "rate_limit": { "$ref": "#/definitions/codersdk.RateLimitConfig" }, "scim_api_key": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "secure_auth_cookie": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "ssh_keygen_algorithm": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "swagger": { "$ref": "#/definitions/codersdk.SwaggerConfig" }, "telemetry": { "$ref": "#/definitions/codersdk.TelemetryConfig" }, "tls": { "$ref": "#/definitions/codersdk.TLSConfig" }, "trace": { "$ref": "#/definitions/codersdk.TraceConfig" }, "update_check": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "wildcard_access_url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" } } }, "codersdk.DeploymentConfigField-array_codersdk_GitAuthConfig": { "type": "object", "properties": { "default": { "type": "array", "items": { "$ref": "#/definitions/codersdk.GitAuthConfig" } }, "enterprise": { "type": "boolean" }, "flag": { "type": "string" }, "hidden": { "type": "boolean" }, "name": { "type": "string" }, "secret": { "type": "boolean" }, "shorthand": { "type": "string" }, "usage": { "type": "string" }, "value": { "$ref": "#/definitions/codersdk.GitAuthConfig" } } }, "codersdk.DeploymentConfigField-array_string": { "type": "object", "properties": { "default": { "type": "array", "items": { "type": "string" } }, "enterprise": { "type": "boolean" }, "flag": { "type": "string" }, "hidden": { "type": "boolean" }, "name": { "type": "string" }, "secret": { "type": "boolean" }, "shorthand": { "type": "string" }, "usage": { "type": "string" }, "value": { "type": "string" } } }, "codersdk.DeploymentConfigField-bool": { "type": "object", "properties": { "default": { "type": "boolean" }, "enterprise": { "type": "boolean" }, "flag": { "type": "string" }, "hidden": { "type": "boolean" }, "name": { "type": "string" }, "secret": { "type": "boolean" }, "shorthand": { "type": "string" }, "usage": { "type": "string" }, "value": { "type": "boolean" } } }, "codersdk.DeploymentConfigField-int": { "type": "object", "properties": { "default": { "type": "integer" }, "enterprise": { "type": "boolean" }, "flag": { "type": "string" }, "hidden": { "type": "boolean" }, "name": { "type": "string" }, "secret": { "type": "boolean" }, "shorthand": { "type": "string" }, "usage": { "type": "string" }, "value": { "type": "integer" } } }, "codersdk.DeploymentConfigField-string": { "type": "object", "properties": { "default": { "type": "string" }, "enterprise": { "type": "boolean" }, "flag": { "type": "string" }, "hidden": { "type": "boolean" }, "name": { "type": "string" }, "secret": { "type": "boolean" }, "shorthand": { "type": "string" }, "usage": { "type": "string" }, "value": { "type": "string" } } }, "codersdk.DeploymentConfigField-time_Duration": { "type": "object", "properties": { "default": { "type": "integer" }, "enterprise": { "type": "boolean" }, "flag": { "type": "string" }, "hidden": { "type": "boolean" }, "name": { "type": "string" }, "secret": { "type": "boolean" }, "shorthand": { "type": "string" }, "usage": { "type": "string" }, "value": { "type": "integer" } } }, "codersdk.GetAppHostResponse": { "type": "object", "properties": { "host": { "description": "Host is the externally accessible URL for the Coder instance.", "type": "string" } } }, "codersdk.GitAuthConfig": { "type": "object", "properties": { "auth_url": { "type": "string" }, "client_id": { "type": "string" }, "id": { "type": "string" }, "no_refresh": { "type": "boolean" }, "regex": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "token_url": { "type": "string" }, "type": { "type": "string" }, "validate_url": { "type": "string" } } }, "codersdk.GoogleInstanceIdentityToken": { "type": "object", "required": [ "json_web_token" ], "properties": { "json_web_token": { "type": "string" } } }, "codersdk.Healthcheck": { "type": "object", "properties": { "interval": { "description": "Interval specifies the seconds between each health check.", "type": "integer" }, "threshold": { "description": "Threshold specifies the number of consecutive failed health checks before returning \"unhealthy\".", "type": "integer" }, "url": { "description": "URL specifies the endpoint to check for the app health.", "type": "string" } } }, "codersdk.OAuth2Config": { "type": "object", "properties": { "github": { "$ref": "#/definitions/codersdk.OAuth2GithubConfig" } } }, "codersdk.OAuth2GithubConfig": { "type": "object", "properties": { "allow_everyone": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "allow_signups": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "allowed_orgs": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" }, "allowed_teams": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" }, "client_id": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "client_secret": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "enterprise_base_url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" } } }, "codersdk.OIDCConfig": { "type": "object", "properties": { "allow_signups": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "client_id": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "client_secret": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "email_domain": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" }, "ignore_email_verified": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "issuer_url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "scopes": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" }, "username_field": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" } } }, "codersdk.Parameter": { "description": "Parameter represents a set value for the scope.", "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "destination_scheme": { "type": "string", "enum": [ "none", "environment_variable", "provisioner_variable" ] }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "scope": { "type": "string", "enum": [ "template", "workspace", "import_job" ] }, "scope_id": { "type": "string", "format": "uuid" }, "source_scheme": { "type": "string", "enum": [ "none", "data" ] }, "updated_at": { "type": "string", "format": "date-time" } } }, "codersdk.PostWorkspaceAgentVersionRequest": { "description": "x-apidocgen:skip", "type": "object", "properties": { "version": { "type": "string" } } }, "codersdk.PostWorkspaceAppHealthsRequest": { "type": "object", "properties": { "healths": { "description": "Healths is a map of the workspace app name and the health of the app.", "type": "object", "additionalProperties": { "type": "string" } } } }, "codersdk.PprofConfig": { "type": "object", "properties": { "address": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "enable": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" } } }, "codersdk.PrometheusConfig": { "type": "object", "properties": { "address": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "enable": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" } } }, "codersdk.ProvisionerConfig": { "type": "object", "properties": { "daemon_poll_interval": { "$ref": "#/definitions/codersdk.DeploymentConfigField-time_Duration" }, "daemon_poll_jitter": { "$ref": "#/definitions/codersdk.DeploymentConfigField-time_Duration" }, "daemons": { "$ref": "#/definitions/codersdk.DeploymentConfigField-int" }, "force_cancel_interval": { "$ref": "#/definitions/codersdk.DeploymentConfigField-time_Duration" } } }, "codersdk.ProvisionerJob": { "type": "object", "properties": { "canceled_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "error": { "type": "string" }, "file_id": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "started_at": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "canceling", "canceled", "failed" ] }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "worker_id": { "type": "string", "format": "uuid" } } }, "codersdk.ProvisionerJobLog": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "id": { "type": "integer" }, "log_level": { "type": "string", "enum": [ "trace", "debug", "info", "warn", "error" ] }, "log_source": { "type": "string" }, "output": { "type": "string" }, "stage": { "type": "string" } } }, "codersdk.PutExtendWorkspaceRequest": { "type": "object", "required": [ "deadline" ], "properties": { "deadline": { "type": "string" } } }, "codersdk.RateLimitConfig": { "type": "object", "properties": { "api": { "$ref": "#/definitions/codersdk.DeploymentConfigField-int" }, "disable_all": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" } } }, "codersdk.Response": { "type": "object", "properties": { "detail": { "description": "Detail is a debug message that provides further insight into why the\naction failed. This information can be technical and a regular golang\nerr.Error() text.\n- \"database: too many open connections\"\n- \"stat: too many open files\"", "type": "string" }, "message": { "description": "Message is an actionable message that depicts actions the request took.\nThese messages should be fully formed sentences with proper punctuation.\nExamples:\n- \"A user has been created.\"\n- \"Failed to create a user.\"", "type": "string" }, "validations": { "description": "Validations are form field-specific friendly error messages. They will be\nshown on a form field in the UI. These can also be used to add additional\ncontext if there is a set of errors in the primary 'Message'.", "type": "array", "items": { "$ref": "#/definitions/codersdk.ValidationError" } } } }, "codersdk.Role": { "type": "object", "properties": { "display_name": { "type": "string" }, "name": { "type": "string" } } }, "codersdk.SwaggerConfig": { "type": "object", "properties": { "enable": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" } } }, "codersdk.TLSConfig": { "type": "object", "properties": { "address": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "cert_file": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" }, "client_auth": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "client_ca_file": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "client_cert_file": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "client_key_file": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "enable": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "key_file": { "$ref": "#/definitions/codersdk.DeploymentConfigField-array_string" }, "min_version": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" }, "redirect_http": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" } } }, "codersdk.TelemetryConfig": { "type": "object", "properties": { "enable": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "trace": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "url": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" } } }, "codersdk.Template": { "type": "object", "properties": { "active_user_count": { "description": "ActiveUserCount is set to -1 when loading.", "type": "integer" }, "active_version_id": { "type": "string" }, "allow_user_cancel_workspace_jobs": { "type": "boolean" }, "build_time_stats": { "$ref": "#/definitions/codersdk.TemplateBuildTimeStats" }, "created_at": { "type": "string", "format": "date-time" }, "created_by_id": { "type": "string", "format": "uuid" }, "created_by_name": { "type": "string" }, "default_ttl_ms": { "type": "integer" }, "description": { "type": "string" }, "display_name": { "type": "string" }, "icon": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "organization_id": { "type": "string", "format": "uuid" }, "provisioner": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "workspace_owner_count": { "type": "integer" } } }, "codersdk.TemplateBuildTimeStats": { "type": "object", "additionalProperties": { "$ref": "#/definitions/codersdk.TransitionStats" } }, "codersdk.TraceConfig": { "type": "object", "properties": { "capture_logs": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "enable": { "$ref": "#/definitions/codersdk.DeploymentConfigField-bool" }, "honeycomb_api_key": { "$ref": "#/definitions/codersdk.DeploymentConfigField-string" } } }, "codersdk.TransitionStats": { "type": "object", "properties": { "p50": { "type": "integer", "example": 123 }, "p95": { "type": "integer", "example": 146 } } }, "codersdk.UpdateCheckResponse": { "type": "object", "properties": { "current": { "description": "Current indicates whether the server version is the same as the latest.", "type": "boolean" }, "url": { "description": "URL to download the latest release of Coder.", "type": "string" }, "version": { "description": "Version is the semantic version for the latest release of Coder.", "type": "string" } } }, "codersdk.UpdateWorkspaceAutostartRequest": { "type": "object", "properties": { "schedule": { "type": "string" } } }, "codersdk.UpdateWorkspaceRequest": { "type": "object", "properties": { "name": { "type": "string" } } }, "codersdk.UpdateWorkspaceTTLRequest": { "type": "object", "properties": { "ttl_ms": { "type": "integer" } } }, "codersdk.UploadResponse": { "type": "object", "properties": { "hash": { "type": "string", "format": "uuid" } } }, "codersdk.User": { "type": "object", "required": [ "created_at", "email", "id", "username" ], "properties": { "avatar_url": { "type": "string" }, "created_at": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "last_seen_at": { "type": "string" }, "organization_ids": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/codersdk.Role" } }, "status": { "type": "string" }, "username": { "type": "string" } } }, "codersdk.ValidationError": { "type": "object", "required": [ "detail", "field" ], "properties": { "detail": { "type": "string" }, "field": { "type": "string" } } }, "codersdk.Workspace": { "type": "object", "properties": { "autostart_schedule": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "last_used_at": { "type": "string", "format": "date-time" }, "latest_build": { "$ref": "#/definitions/codersdk.WorkspaceBuild" }, "name": { "type": "string" }, "outdated": { "type": "boolean" }, "owner_id": { "type": "string", "format": "uuid" }, "owner_name": { "type": "string" }, "template_allow_user_cancel_workspace_jobs": { "type": "boolean" }, "template_display_name": { "type": "string" }, "template_icon": { "type": "string" }, "template_id": { "type": "string", "format": "uuid" }, "template_name": { "type": "string" }, "ttl_ms": { "type": "integer" }, "updated_at": { "type": "string", "format": "date-time" } } }, "codersdk.WorkspaceAgent": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/definitions/codersdk.WorkspaceApp" } }, "architecture": { "type": "string" }, "connection_timeout_seconds": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "directory": { "type": "string" }, "disconnected_at": { "type": "string", "format": "date-time" }, "environment_variables": { "type": "object", "additionalProperties": { "type": "string" } }, "first_connected_at": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "instance_id": { "type": "string" }, "last_connected_at": { "type": "string", "format": "date-time" }, "latency": { "description": "DERPLatency is mapped by region name (e.g. \"New York City\", \"Seattle\").", "type": "object", "additionalProperties": { "$ref": "#/definitions/codersdk.DERPRegion" } }, "name": { "type": "string" }, "operating_system": { "type": "string" }, "resource_id": { "type": "string", "format": "uuid" }, "startup_script": { "type": "string" }, "status": { "type": "string", "enum": [ "connecting", "connected", "disconnected", "timeout" ] }, "troubleshooting_url": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": "string" } } }, "codersdk.WorkspaceAgentAuthenticateResponse": { "type": "object", "properties": { "session_token": { "type": "string" } } }, "codersdk.WorkspaceAgentGitAuthResponse": { "type": "object", "properties": { "password": { "type": "string" }, "url": { "type": "string" }, "username": { "type": "string" } } }, "codersdk.WorkspaceAgentMetadata": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/definitions/codersdk.WorkspaceApp" } }, "derpmap": { "$ref": "#/definitions/tailcfg.DERPMap" }, "directory": { "type": "string" }, "environment_variables": { "type": "object", "additionalProperties": { "type": "string" } }, "git_auth_configs": { "description": "GitAuthConfigs stores the number of Git configurations\nthe Coder deployment has. If this number is \u003e0, we\nset up special configuration in the workspace.", "type": "integer" }, "motd_file": { "type": "string" }, "startup_script": { "type": "string" }, "vscode_port_proxy_uri": { "type": "string" } } }, "codersdk.WorkspaceApp": { "type": "object", "properties": { "command": { "type": "string" }, "display_name": { "description": "DisplayName is a friendly name for the app.", "type": "string" }, "external": { "description": "External specifies whether the URL should be opened externally on\nthe client or not.", "type": "boolean" }, "health": { "type": "string" }, "healthcheck": { "description": "Healthcheck specifies the configuration for checking app health.", "$ref": "#/definitions/codersdk.Healthcheck" }, "icon": { "description": "Icon is a relative path or external URL that specifies\nan icon to be displayed in the dashboard.", "type": "string" }, "id": { "type": "string", "format": "uuid" }, "sharing_level": { "type": "string", "enum": [ "owner", "authenticated", "public" ] }, "slug": { "description": "Slug is a unique identifier within the agent.", "type": "string" }, "subdomain": { "description": "Subdomain denotes whether the app should be accessed via a path on the\n` + "`" + `coder server` + "`" + ` or via a hostname-based dev URL. If this is set to true\nand there is no app wildcard configured on the server, the app will not\nbe accessible in the UI.", "type": "boolean" }, "url": { "description": "URL is the address being proxied to inside the workspace.\nIf external is specified, this will be opened on the client.", "type": "string" } } }, "codersdk.WorkspaceBuild": { "type": "object", "properties": { "build_number": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "daily_cost": { "type": "integer" }, "deadline": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "initiator_id": { "type": "string", "format": "uuid" }, "initiator_name": { "type": "string" }, "job": { "$ref": "#/definitions/codersdk.ProvisionerJob" }, "reason": { "type": "string", "enum": [ "initiator", "autostart", "autostop" ] }, "resources": { "type": "array", "items": { "$ref": "#/definitions/codersdk.WorkspaceResource" } }, "status": { "type": "string", "enum": [ "pending", "starting", "running", "stopping", "stopped", "failed", "canceling", "canceled", "deleting", "deleted" ] }, "template_version_id": { "type": "string", "format": "uuid" }, "template_version_name": { "type": "string" }, "transition": { "type": "string", "enum": [ "start", "stop", "delete" ] }, "updated_at": { "type": "string", "format": "date-time" }, "workspace_id": { "type": "string", "format": "uuid" }, "workspace_name": { "type": "string" }, "workspace_owner_id": { "type": "string", "format": "uuid" }, "workspace_owner_name": { "type": "string" } } }, "codersdk.WorkspaceResource": { "type": "object", "properties": { "agents": { "type": "array", "items": { "$ref": "#/definitions/codersdk.WorkspaceAgent" } }, "created_at": { "type": "string", "format": "date-time" }, "daily_cost": { "type": "integer" }, "hide": { "type": "boolean" }, "icon": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "job_id": { "type": "string", "format": "uuid" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/codersdk.WorkspaceResourceMetadata" } }, "name": { "type": "string" }, "type": { "type": "string" }, "workspace_transition": { "type": "string", "enum": [ "start", "stop", "delete" ] } } }, "codersdk.WorkspaceResourceMetadata": { "type": "object", "properties": { "key": { "type": "string" }, "sensitive": { "type": "boolean" }, "value": { "type": "string" } } }, "codersdk.WorkspacesResponse": { "type": "object", "properties": { "count": { "type": "integer" }, "workspaces": { "type": "array", "items": { "$ref": "#/definitions/codersdk.Workspace" } } } }, "netip.Addr": { "type": "object" }, "tailcfg.DERPMap": { "type": "object", "properties": { "omitDefaultRegions": { "description": "OmitDefaultRegions specifies to not use Tailscale's DERP servers, and only use those\nspecified in this DERPMap. If there are none set outside of the defaults, this is a noop.", "type": "boolean" }, "regions": { "description": "Regions is the set of geographic regions running DERP node(s).\n\nIt's keyed by the DERPRegion.RegionID.\n\nThe numbers are not necessarily contiguous.", "type": "object", "additionalProperties": { "$ref": "#/definitions/tailcfg.DERPRegion" } } } }, "tailcfg.DERPNode": { "type": "object", "properties": { "certName": { "description": "CertName optionally specifies the expected TLS cert common\nname. If empty, HostName is used. If CertName is non-empty,\nHostName is only used for the TCP dial (if IPv4/IPv6 are\nnot present) + TLS ClientHello.", "type": "string" }, "derpport": { "description": "DERPPort optionally provides an alternate TLS port number\nfor the DERP HTTPS server.\n\nIf zero, 443 is used.", "type": "integer" }, "forceHTTP": { "description": "ForceHTTP is used by unit tests to force HTTP.\nIt should not be set by users.", "type": "boolean" }, "hostName": { "description": "HostName is the DERP node's hostname.\n\nIt is required but need not be unique; multiple nodes may\nhave the same HostName but vary in configuration otherwise.", "type": "string" }, "insecureForTests": { "description": "InsecureForTests is used by unit tests to disable TLS verification.\nIt should not be set by users.", "type": "boolean" }, "ipv4": { "description": "IPv4 optionally forces an IPv4 address to use, instead of using DNS.\nIf empty, A record(s) from DNS lookups of HostName are used.\nIf the string is not an IPv4 address, IPv4 is not used; the\nconventional string to disable IPv4 (and not use DNS) is\n\"none\".", "type": "string" }, "ipv6": { "description": "IPv6 optionally forces an IPv6 address to use, instead of using DNS.\nIf empty, AAAA record(s) from DNS lookups of HostName are used.\nIf the string is not an IPv6 address, IPv6 is not used; the\nconventional string to disable IPv6 (and not use DNS) is\n\"none\".", "type": "string" }, "name": { "description": "Name is a unique node name (across all regions).\nIt is not a host name.\nIt's typically of the form \"1b\", \"2a\", \"3b\", etc. (region\nID + suffix within that region)", "type": "string" }, "regionID": { "description": "RegionID is the RegionID of the DERPRegion that this node\nis running in.", "type": "integer" }, "stunonly": { "description": "STUNOnly marks a node as only a STUN server and not a DERP\nserver.", "type": "boolean" }, "stunport": { "description": "Port optionally specifies a STUN port to use.\nZero means 3478.\nTo disable STUN on this node, use -1.", "type": "integer" }, "stuntestIP": { "description": "STUNTestIP is used in tests to override the STUN server's IP.\nIf empty, it's assumed to be the same as the DERP server.", "type": "string" } } }, "tailcfg.DERPRegion": { "type": "object", "properties": { "avoid": { "description": "Avoid is whether the client should avoid picking this as its home\nregion. The region should only be used if a peer is there.\nClients already using this region as their home should migrate\naway to a new region without Avoid set.", "type": "boolean" }, "embeddedRelay": { "description": "EmbeddedRelay is true when the region is bundled with the Coder\ncontrol plane.", "type": "boolean" }, "nodes": { "description": "Nodes are the DERP nodes running in this region, in\npriority order for the current client. Client TLS\nconnections should ideally only go to the first entry\n(falling back to the second if necessary). STUN packets\nshould go to the first 1 or 2.\n\nIf nodes within a region route packets amongst themselves,\nbut not to other regions. That said, each user/domain\nshould get a the same preferred node order, so if all nodes\nfor a user/network pick the first one (as they should, when\nthings are healthy), the inter-cluster routing is minimal\nto zero.", "type": "array", "items": { "$ref": "#/definitions/tailcfg.DERPNode" } }, "regionCode": { "description": "RegionCode is a short name for the region. It's usually a popular\ncity or airport code in the region: \"nyc\", \"sf\", \"sin\",\n\"fra\", etc.", "type": "string" }, "regionID": { "description": "RegionID is a unique integer for a geographic region.\n\nIt corresponds to the legacy derpN.tailscale.com hostnames\nused by older clients. (Older clients will continue to resolve\nderpN.tailscale.com when contacting peers, rather than use\nthe server-provided DERPMap)\n\nRegionIDs must be non-zero, positive, and guaranteed to fit\nin a JavaScript number.\n\nRegionIDs in range 900-999 are reserved for end users to run their\nown DERP nodes.", "type": "integer" }, "regionName": { "description": "RegionName is a long English name for the region: \"New York City\",\n\"San Francisco\", \"Singapore\", \"Frankfurt\", etc.", "type": "string" } } } }, "securityDefinitions": { "CoderSessionToken": { "type": "apiKey", "name": "Coder-Session-Token", "in": "header" } } }` // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "2.0", Host: "", BasePath: "/api/v2", Schemes: []string{}, Title: "Coder API", Description: "Coderd is the service created by running coder server. It is a thin API that connects workspaces, provisioners and users. coderd stores its state in Postgres and is the only service that communicates with Postgres.", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, } func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) }

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

3742

3743

3744

3745

3746

3747

3748

3749

3750

3751

3752

3753

3754

3755

3756

3757

3758

3759

3760

3761

3762

3763

3764

3765

3766

3767

3768

3769

3770

3771

3772

3773

3774

3775

3776

3777

3778

3779

3780

3781

3782

3783

3784

3785

3786

3787

3788

3789

3790

3791

3792

3793

3794

3795

3796

3797

3798

3799

3800

3801

3802

3803

3804

3805

3806

3807

3808

3809

3810

3811

3812

3813

3814

3815