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

Launch a static website Checks required customer-role capabilities, creates a static website, and starts an asynchronous build/deployment workflow. GitHub source only. Dockerfile, port, and health_path fields are rejected; unsupported fields are otherwise ignored. No compute or VPC configuration is 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}/static_websites/{id}

Show a static website

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

Update build settings or auto-deploy Writes build_command, output_directory, spa_rewrite, and/or deploy_branch_pattern. Does not start a workflow. 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}/static_websites/{id}

Tear down a static website Starts StaticWebsite::Teardown. Does not delete 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}/static_websites/{id}

Update build settings or auto-deploy Writes build_command, output_directory, spa_rewrite, and/or deploy_branch_pattern. Does not start a workflow. 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}/static_websites/{id}/cost

Static website cost estimate

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

Read static website environment variables Build variables only. Omitted scope or scope=build is accepted. Other scopes are rejected. Save replaces all variables, and does not deploy. Values can be included in public output.

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

Replace static website environment variables Build variables only. Omitted scope or scope=build is accepted. Other scopes are rejected. Save replaces all variables, and does not deploy. Values can be included in public output. 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}/static_websites/{id}/logs

Static website logs CodeBuild output only (source=build).

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

Static website metrics CloudFront request, 4xx, and 5xx widgets.

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

Create a preview of a static website 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}/static_websites/{id}/previews/{preview_id}

Show a static website preview

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

Tear down a static website 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}/static_websites/{id}/previews/{preview_id}/environment

Environment preview Build variables only. Omitted scope or scope=build is accepted. Other scopes are rejected. Save replaces all variables, and does not deploy. Values can be included in public output.

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

Update Environment preview Build variables only. Omitted scope or scope=build is accepted. Other scopes are rejected. Save replaces all variables, and does not deploy. Values can be included in public output. 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}/static_websites/{id}/previews/{preview_id}/logs

Logs preview

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

Metrics preview

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

Redeploy a static website Starts another StaticWebsite::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.

GET /api/projects/{project_id}/static_websites/{id}/screenshot

Screenshot static website

Referenced definitions

These keys resolve the local references in the operations above.