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}/workers

Launch a worker Checks the customer IAM role without ELBv2 actions, creates the Resource, and starts Worker::BuildAndDeploy. Rejects port and health_path. 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}/workers/{id}

Show a worker

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

Update desired source, compute, or auto-deploy Writes root_directory, dockerfile_path, container_command, vcpu, memory_gb, min_copies, max_copies, deploy_branch_pattern, and/or ebs_size_gib with ebs_mount_path. 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. Rejects port and health_path. Does not start a workflow. A data volume applies on the next Redeploy. Null size and path clear it. 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}/workers/{id}

Tear down a worker Starts Worker::Teardown. The last compute resource also deletes the project VPC. 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}/workers/{id}

Update desired source, compute, or auto-deploy Writes root_directory, dockerfile_path, container_command, vcpu, memory_gb, min_copies, max_copies, deploy_branch_pattern, and/or ebs_size_gib with ebs_mount_path. 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. Rejects port and health_path. Does not start a workflow. A data volume applies on the next Redeploy. Null size and path clear it. 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}/workers/{id}/cost

Worker cost estimate

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

Read worker 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}/workers/{id}/environment

Replace worker 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}/workers/{id}/logs

Worker logs

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

Worker metrics CPU, memory, and replica widgets. ALB request/5xx widgets are omitted unless the run stored a load balancer.

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

Pause worker 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}/workers/{id}/previews

Create a preview of a worker 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}/workers/{id}/previews/{preview_id}

Show a worker preview

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

Tear down a worker 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.

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

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.

PUT /api/projects/{project_id}/workers/{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}/workers/{id}/previews/{preview_id}/logs

Logs preview

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

Metrics preview

POST /api/projects/{project_id}/workers/{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}/workers/{id}/redeploy

Redeploy a worker Starts another Worker::BuildAndDeploy from the last run’s input. 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}/workers/{id}/resume

Resume worker 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}/workers/{id}/tasks

List observed ECS tasks Returns live task state for the worker 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.