Refactor init-script endpoint to use path params instead of query params

kacpersaw · kacpersaw · commit c462a6916a1a · 2025-08-06T13:21:05.000Z
diff --git a/cli/external_workspaces.go b/cli/external_workspaces.go
@@ -133,11 +133,7 @@ func (r *RootCmd) externalWorkspaceAgentInstructions() *serpent.Command {
 				return xerrors.Errorf("get external agent token for agent %q: %w", workspaceAgent.Name, err)
 			}
 
-			initScriptURL := fmt.Sprintf("%s/api/v2/init-script", client.URL)
-			if workspaceAgent.OperatingSystem != "linux" || workspaceAgent.Architecture != "amd64" {
-				initScriptURL = fmt.Sprintf("%s/api/v2/init-script?os=%s&arch=%s", client.URL, workspaceAgent.OperatingSystem, workspaceAgent.Architecture)
-			}
-
+			initScriptURL := fmt.Sprintf("%s/api/v2/init-script/%s/%s", client.URL, workspaceAgent.OperatingSystem, workspaceAgent.Architecture)
 			agentInfo := externalAgent{
 				WorkspaceName: workspace.Name,
 				AgentName:     workspaceAgent.Name,
@@ -244,11 +240,7 @@ func fetchExternalAgents(inv *serpent.Invocation, client *codersdk.Client, works
 			return nil, xerrors.Errorf("get external agent token for agent %q: %w", agent.Name, err)
 		}
 
-		initScriptURL := fmt.Sprintf("%s/api/v2/init-script", client.URL)
-		if agent.OperatingSystem != "linux" || agent.Architecture != "amd64" {
-			initScriptURL = fmt.Sprintf("%s/api/v2/init-script?os=%s&arch=%s", client.URL, agent.OperatingSystem, agent.Architecture)
-		}
-
+		initScriptURL := fmt.Sprintf("%s/api/v2/init-script/%s/%s", client.URL, agent.OperatingSystem, agent.Architecture)
 		externalAgents = append(externalAgents, externalAgent{
 			AgentName:  agent.Name,
 			AuthType:   "token",
diff --git a/cli/external_workspaces_test.go b/cli/external_workspaces_test.go
@@ -374,7 +374,7 @@ func TestExternalWorkspaces(t *testing.T) {
 		require.NoError(t, json.Unmarshal(out.Bytes(), &agentInfo))
 		assert.Equal(t, "token", agentInfo["auth_type"])
 		assert.NotEmpty(t, agentInfo["auth_token"])
-		assert.Contains(t, agentInfo["init_script"], "/api/v2/init-script")
+		assert.Contains(t, agentInfo["init_script"], "/api/v2/init-script/linux/amd64")
 	})
 
 	t.Run("AgentInstructionsNonExistentWorkspace", func(t *testing.T) {
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -1551,7 +1551,7 @@ func New(options *Options) *API {
 			r.Get("/", api.tailnetRPCConn)
 		})
 		r.Route("/init-script", func(r chi.Router) {
-			r.Get("/", api.initScript)
+			r.Get("/{os}/{arch}", api.initScript)
 		})
 	})
 
diff --git a/coderd/init_script.go b/coderd/init_script.go
@@ -5,33 +5,30 @@ import (
 	"net/http"
 	"strings"
 
+	"github.com/go-chi/chi/v5"
+
 	"github.com/coder/coder/v2/provisionersdk"
 )
 
 // @Summary Get agent init script
 // @ID get-agent-init-script
 // @Produce text/plain
 // @Tags InitScript
-// @Param os query string false "Operating system" default "linux"
-// @Param arch query string false "Architecture" default "amd64"
+// @Param os path string true "Operating system"
+// @Param arch path string true "Architecture"
 // @Success 200 "Success"
-// @Router /init-script [get]
+// @Router /init-script/{os}/{arch} [get]
 func (api *API) initScript(rw http.ResponseWriter, r *http.Request) {
-	os := "linux"
-	arch := "amd64"
-	if os := r.URL.Query().Get("os"); os != "" {
-		os = strings.ToLower(os)
-		if os != "linux" && os != "darwin" && os != "windows" {
-			rw.WriteHeader(http.StatusBadRequest)
-			return
-		}
+	os := strings.ToLower(chi.URLParam(r, "os"))
+	arch := strings.ToLower(chi.URLParam(r, "arch"))
+
+	if os != "linux" && os != "darwin" && os != "windows" {
+		rw.WriteHeader(http.StatusBadRequest)
+		return
 	}
-	if arch := r.URL.Query().Get("arch"); arch != "" {
-		arch = strings.ToLower(arch)
-		if arch != "amd64" && arch != "arm64" && arch != "armv7" {
-			rw.WriteHeader(http.StatusBadRequest)
-			return
-		}
+	if arch != "amd64" && arch != "arm64" && arch != "armv7" {
+		rw.WriteHeader(http.StatusBadRequest)
+		return
 	}
 
 	script, exists := provisionersdk.AgentScriptEnv()[fmt.Sprintf("CODER_AGENT_SCRIPT_%s_%s", os, arch)]
diff --git a/site/src/modules/resources/AgentExternal.tsx b/site/src/modules/resources/AgentExternal.tsx
@@ -21,11 +21,7 @@ export const AgentExternal: FC<AgentExternalProps> = ({
 	);
 
 	const origin = isChromatic() ? "https://example.com" : window.location.origin;
-	let initScriptURL = `${origin}/api/v2/init-script`;
-	if (agent.operating_system !== "linux" || agent.architecture !== "amd64") {
-		initScriptURL = `${initScriptURL}?os=${agent.operating_system}&arch=${agent.architecture}`;
-	}
-
+	const initScriptURL = `${origin}/api/v2/init-script/${agent.operating_system}/${agent.architecture}`;
 	useEffect(() => {
 		if (
 			isExternalAgent &&
