Skip to main content
The Springwinter REST API (version 0.1.0, OpenAPI Specification 3.1) is available at https://springwinter.dev/api and gives you programmatic access to every feature exposed by the control plane — deploying services, managing environment variables, reading logs and metrics, connecting AWS accounts, and more. You can explore and call the API interactively at https://springwinter.dev/docs/api after signing in at /auth.

​
Base URL

All API endpoints share a single base URL:
Prepend this to every path shown in the reference. For example, the projects list endpoint is reachable at https://springwinter.dev/api/projects.

​
API Version

The current API version is 0.1.0. The version is reflected in the OpenAPI document served at https://springwinter.dev/docs/api.

​
Authentication

The API supports two authentication methods:
  • Bearer token — recommended for all automated and programmatic access. Create a token in Settings → API Tokens, then pass it in the Authorization header.
  • Cookie session + CSRF token — used by the Springwinter browser dashboard. Sign in via POST /api/session, then fetch a CSRF token from GET /api/csrf and include it as X-CSRF-Token on every mutating request.
See the Authentication page for full details and code examples.

​
Request Format

For POST, PATCH, and PUT requests, send a JSON body and include the Content-Type: application/json header:
GET and DELETE requests do not require a request body.

​
Response Format

All responses are JSON. The API follows standard HTTP status code conventions:

​
Resources

Use the cards below to jump directly to the reference section for each resource group.

Session

Sign in, retrieve the current user, and sign out.

API Tokens

Create and revoke long-lived API bearer tokens.

Projects

Manage projects and HTTPS certificates.

Web Servers

Deploy, redeploy, and manage containerised web servers.

Workers

Deploy and manage background worker services.

Static Websites

Deploy static sites backed by S3 and CloudFront.

Caches

Provision and manage Valkey (Redis-compatible) caches.

Storage

Create and manage private S3 storage buckets.

Bedrock

Configure and access AWS Bedrock AI models.

AWS

Connect and verify your AWS account.

GitHub

Manage GitHub App installations and repository access.