Skip to main content
Generated from the application OpenAPI contract. Do not edit endpoint examples independently. Read the agent guide before automating deployments. Fetch the public schema with GET /api/openapi.json; no token is needed to read it. Customer data and deployment operations still require authentication. The interactive reference is in the app. Authenticated operations accept Authorization: Bearer $SPRINGWINTER_TOKEN. Cookie mutations require a CSRF token. Signed webhooks use their own signature checks. Read each operation’s security setting.

POST /api/projects/{project_id}/web_servers

Launch a web server Checks the customer IAM role with iam:SimulatePrincipalPolicy, creates the Resource, and starts WebServer::BuildAndDeploy. Deployment provisions the Spring Winter hostname and ACM certificate for every project, including those with a custom hostname. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

GET /api/projects/{project_id}/web_servers/{id}

Show a web server

PATCH /api/projects/{project_id}/web_servers/{id}

Update desired source, compute, health path, or auto-deploy Writes root_directory, dockerfile_path, port, container_command, vcpu, memory_gb, min_copies, max_copies, spot_mode, health_path, deploy_branch_pattern, and/or ebs_size_gib with ebs_mount_path on the resource. Does not start a workflow. Allowed during deploy; rejected during teardown. dockerfile_path stays relative to the repository root. root_directory selects the Docker build context, defaults to ., and accepts an empty value to reset it. Both apply on the next Redeploy. container_command replaces the image command on the next Redeploy or Environment save; blank keeps the Dockerfile command. port is the container listen port (1–65535). An empty deploy_branch_pattern turns auto-deploy off. A blank health_path stores /. A data volume applies on the next Redeploy. Spot modes are rejected with a data volume and apply on the next Redeploy. Null size and path clear it. Image sources can update image; GitHub sources can update dockerfile_path and root_directory. Source type cannot be changed. service_hostname is also accepted. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

DELETE /api/projects/{project_id}/web_servers/{id}

Tear down a web server Starts WebServer::Teardown. The resource is soft-deleted only after AWS destroy succeeds. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

PUT /api/projects/{project_id}/web_servers/{id}

Update desired source, compute, health path, or auto-deploy Writes root_directory, dockerfile_path, port, container_command, vcpu, memory_gb, min_copies, max_copies, spot_mode, health_path, deploy_branch_pattern, and/or ebs_size_gib with ebs_mount_path on the resource. Does not start a workflow. Allowed during deploy; rejected during teardown. dockerfile_path stays relative to the repository root. root_directory selects the Docker build context, defaults to ., and accepts an empty value to reset it. Both apply on the next Redeploy. container_command replaces the image command on the next Redeploy or Environment save; blank keeps the Dockerfile command. port is the container listen port (1–65535). An empty deploy_branch_pattern turns auto-deploy off. A blank health_path stores /. A data volume applies on the next Redeploy. Spot modes are rejected with a data volume and apply on the next Redeploy. Null size and path clear it. Image sources can update image; GitHub sources can update dockerfile_path and root_directory. Source type cannot be changed. service_hostname is also accepted. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

GET /api/projects/{project_id}/web_servers/{id}/cost

Estimated spend Catalog on-demand USD for tagged resources Spring Winter created. Not Cost Explorer billed usage and not the AWS invoice. Includes cost_explorer_url, a console deep link filtered by the project tag; customers must activate that cost allocation tag in Billing.

GET /api/projects/{project_id}/web_servers/{id}/environment

Read ECS environment variables Omitted scope uses runtime variables. scope=build uses AWS CodeBuild variables for GitHub sources. Public-image sources reject build scope. Build saves apply on the next build and do not deploy. Docker builds require matching Dockerfile ARG names. Build values remain in AWS.

PUT /api/projects/{project_id}/web_servers/{id}/environment

Replace ECS environment variables Omitted scope uses runtime variables. scope=build uses AWS CodeBuild variables for GitHub sources. Public-image sources reject build scope. Build saves apply on the next build and do not deploy. Docker builds require matching Dockerfile ARG names. Build values remain in AWS. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

GET /api/projects/{project_id}/web_servers/{id}/logs

Tail CloudWatch logs CodeBuild or ECS CloudWatch events for this resource. Includes console_url, a CloudWatch Logs Insights deep link for the current source’s log group. Does not call StartQuery.

GET /api/projects/{project_id}/web_servers/{id}/metrics

CloudWatch metrics CPU, memory, running replica count, ALB requests, and target 5xx for the selected range. Does not persist datapoints.

POST /api/projects/{project_id}/web_servers/{id}/pause

Pause web server For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

POST /api/projects/{project_id}/web_servers/{id}/previews

Create a preview of a web server Creates a child from saved parent configuration. Requires a previous deployment and a GitHub source. Choose branch with branch, or commit with git_sha. A full 40-character SHA is accepted directly; other refs are resolved through GitHub. Public-image parents return invalid_preview. Child workflow success must be checked separately. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

GET /api/projects/{project_id}/web_servers/{id}/previews/{preview_id}

Show a web server preview

DELETE /api/projects/{project_id}/web_servers/{id}/previews/{preview_id}

Tear down a web server preview Starts WebServer::Teardown on the child only. Production is unchanged. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

GET /api/projects/{project_id}/web_servers/{id}/previews/{preview_id}/environment

Read preview environment variables Omitted scope uses runtime variables. scope=build uses AWS CodeBuild variables for GitHub sources. Public-image sources reject build scope. Build saves apply on the next build and do not deploy. Docker builds require matching Dockerfile ARG names. Build values remain in AWS.

PUT /api/projects/{project_id}/web_servers/{id}/previews/{preview_id}/environment

Update Environment preview Omitted scope uses runtime variables. scope=build uses AWS CodeBuild variables for GitHub sources. Public-image sources reject build scope. Build saves apply on the next build and do not deploy. Docker builds require matching Dockerfile ARG names. Build values remain in AWS. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

GET /api/projects/{project_id}/web_servers/{id}/previews/{preview_id}/logs

Tail CloudWatch logs for a preview Same LogPage as production logs, including console_url for the child resource’s log group.

GET /api/projects/{project_id}/web_servers/{id}/previews/{preview_id}/metrics

Read CloudWatch metrics for a preview

POST /api/projects/{project_id}/web_servers/{id}/previews/{preview_id}/redeploy

Redeploy preview For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

POST /api/projects/{project_id}/web_servers/{id}/redeploy

Redeploy a web server Starts another WebServer::BuildAndDeploy from the last run’s input. Compute comes from the resource. existing (default) rebuilds the last stored commit SHA; branch resolves HEAD through GitHub; commit uses the SHA. Public-image resources use the saved image reference and ignore Git ref selection. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

POST /api/projects/{project_id}/web_servers/{id}/resume

Resume web server For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.

GET /api/projects/{project_id}/web_servers/{id}/tasks

List observed ECS tasks Returns live task state for the service. Includes task ID, status, health, start time, availability zone, capacity provider, task definition revision, private IP, and container status. Does not return task environment values.

Referenced definitions

These keys resolve the local references in the operations above.