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}/redis
Enable a Valkey cache
Checks ElastiCache and project-network permissions, creates a managed redis resource, and starts Redis::Provision. Memory is an integer GB from 1 to 8. There is no password. 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.
{
"tags": [
"Cache"
],
"summary": "Enable a Valkey cache",
"description": "Checks ElastiCache and project-network permissions, creates a managed `redis` resource, and starts `Redis::Provision`. Memory is an integer GB from 1 to 8. There is no password. 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.",
"operationId": "createRedisCache",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"redis"
],
"properties": {
"redis": {
"type": "object",
"required": [
"name",
"memory_gb"
],
"properties": {
"name": {
"type": "string"
},
"memory_gb": {
"type": "integer",
"minimum": 1,
"maximum": 8,
"example": 1
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/AccountDataRedis"
},
"workflow_run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"resource",
"workflow_run_id"
]
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found; redis_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"redis_not_found"
]
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "invalid_csrf_token; missing_aws_account; missing_permissions; invalid_redis; name_taken",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_csrf_token",
"missing_aws_account",
"missing_permissions",
"invalid_redis",
"name_taken"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error"
]
}
}
}
},
"400": {
"description": "invalid_parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_parameters"
]
}
},
"required": [
"error"
]
}
}
}
}
}
}
GET /api/projects/{project_id}/redis/{id}
Show a Valkey cache
{
"tags": [
"Cache"
],
"summary": "Show a Valkey cache",
"operationId": "getRedisCache",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/AccountDataRedis"
},
"workflow_run": {
"anyOf": [
{
"$ref": "#/components/schemas/AccountDataWorkflow"
},
{
"type": "null"
}
]
},
"teardown_run": {
"anyOf": [
{
"$ref": "#/components/schemas/AccountDataWorkflow"
},
{
"type": "null"
}
]
},
"workflow_runs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountDataWorkflow"
}
}
},
"required": [
"resource",
"workflow_run",
"teardown_run",
"workflow_runs"
]
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found; redis_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"redis_not_found"
]
}
},
"required": [
"error"
]
}
}
}
}
}
}
DELETE /api/projects/{project_id}/redis/{id}
Delete a Valkey cache
Starts Redis::Teardown. The project VPC stays while a web server, worker, or another cache remains. 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.
{
"tags": [
"Cache"
],
"summary": "Delete a Valkey cache",
"description": "Starts `Redis::Teardown`. The project VPC stays while a web server, worker, or another cache remains. 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.",
"operationId": "deleteRedisCache",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/AccountDataRedis"
},
"workflow_run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"resource",
"workflow_run_id"
]
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found; redis_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"redis_not_found"
]
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "workflow_in_progress",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "invalid_csrf_token; missing_aws_account; missing_permissions; invalid_redis",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_csrf_token",
"missing_aws_account",
"missing_permissions",
"invalid_redis"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error"
]
}
}
}
},
"400": {
"description": "invalid_parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_parameters"
]
}
},
"required": [
"error"
]
}
}
}
}
}
}
PATCH /api/projects/{project_id}/redis/{id}
Change a Valkey cache storage limit
Sets the integer GB data-storage maximum from 1 to 8. An available cache is updated with ModifyServerlessCache. A cache that is still pending stores the new limit for creation. A running workflow returns 409. 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.
{
"tags": [
"Cache"
],
"summary": "Change a Valkey cache storage limit",
"description": "Sets the integer GB data-storage maximum from 1 to 8. An available cache is updated with ModifyServerlessCache. A cache that is still pending stores the new limit for creation. A running workflow returns 409. 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.",
"operationId": "updateRedisCache",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/AccountDataRedis"
}
},
"required": [
"resource"
]
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found; redis_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"redis_not_found"
]
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "workflow_in_progress",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "invalid_csrf_token; missing_aws_account; missing_permissions; invalid_redis; aws_credentials_invalid",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_csrf_token",
"missing_aws_account",
"missing_permissions",
"invalid_redis",
"aws_credentials_invalid"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error"
]
}
}
}
},
"400": {
"description": "invalid_parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_parameters"
]
}
},
"required": [
"error"
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redis": {
"type": "object",
"properties": {
"memory_gb": {
"type": "number",
"minimum": 1,
"maximum": 8,
"multipleOf": 1
}
},
"required": [
"memory_gb"
]
}
},
"required": [
"redis"
]
}
}
}
}
}
PUT /api/projects/{project_id}/redis/{id}
Change a Valkey cache storage limit
Sets the integer GB data-storage maximum from 1 to 8. An available cache is updated with ModifyServerlessCache. A cache that is still pending stores the new limit for creation. A running workflow returns 409. 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.
{
"tags": [
"Cache"
],
"summary": "Change a Valkey cache storage limit",
"operationId": "putApiProjectsProjectIdRedisId",
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/AccountDataRedis"
}
},
"required": [
"resource"
]
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found; redis_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"redis_not_found"
]
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "workflow_in_progress",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "invalid_csrf_token; missing_aws_account; missing_permissions; invalid_redis; aws_credentials_invalid",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_csrf_token",
"missing_aws_account",
"missing_permissions",
"invalid_redis",
"aws_credentials_invalid"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error"
]
}
}
}
},
"400": {
"description": "invalid_parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_parameters"
]
}
},
"required": [
"error"
]
}
}
}
}
},
"description": "Sets the integer GB data-storage maximum from 1 to 8. An available cache is updated with ModifyServerlessCache. A cache that is still pending stores the new limit for creation. A running workflow returns 409. 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.",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redis": {
"type": "object",
"properties": {
"memory_gb": {
"type": "number",
"minimum": 1,
"maximum": 8,
"multipleOf": 1
}
},
"required": [
"memory_gb"
]
}
},
"required": [
"redis"
]
}
}
}
}
}
GET /api/projects/{project_id}/redis/{id}/cost
Estimated Valkey spend
Catalog on-demand USD for data stored, using the US East (N. Virginia) Valkey Serverless rate of $0.084 per GB-hour and a 100 MB minimum. ECPUs are listed at $0 because request volume is not forecast ($0.0023 per million). The 1–8 GB storage cap is not the bill. Includes the same project Cost Explorer link as a web server. A denied CloudWatch read still returns the minimum.
{
"tags": [
"Cache"
],
"summary": "Estimated Valkey spend",
"description": "Catalog on-demand USD for data stored, using the US East (N. Virginia) Valkey Serverless rate of $0.084 per GB-hour and a 100 MB minimum. ECPUs are listed at $0 because request volume is not forecast ($0.0023 per million). The 1–8 GB storage cap is not the bill. Includes the same project Cost Explorer link as a web server. A denied CloudWatch read still returns the minimum.",
"operationId": "getRedisCacheCost",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostPage"
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found; redis_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"redis_not_found"
]
}
},
"required": [
"error"
]
}
}
}
}
}
}
GET /api/projects/{project_id}/redis/{id}/metrics
Valkey cache CloudWatch metrics
Data stored, ECPUs, connections, and cache hit rate for the serverless cache. Dimension is clusterId, the cache name.
{
"tags": [
"Cache"
],
"summary": "Valkey cache CloudWatch metrics",
"description": "Data stored, ECPUs, connections, and cache hit rate for the serverless cache. Dimension is clusterId, the cache name.",
"operationId": "getRedisCacheMetrics",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "range",
"in": "query",
"schema": {
"type": "string",
"enum": [
"1h",
"3h",
"12h",
"1d"
]
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsPage"
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found; redis_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"redis_not_found"
]
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "missing_permissions; aws_credentials_invalid",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"missing_permissions",
"aws_credentials_invalid"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error"
]
}
}
}
}
}
}
Referenced definitions
These keys resolve the local references in the operations above.{
"#/components/parameters/ProjectIdInPath": {
"name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"#/components/schemas/AccountDataRedis": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string"
},
"status": {
"type": "string"
},
"memory_gb": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cache_endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"cache_reader_endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"kind",
"status",
"memory_gb",
"cache_endpoint",
"cache_reader_endpoint"
]
},
"#/components/schemas/AccountDataWorkflow": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"current_step": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"in_progress": {
"type": "boolean"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"started_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"finished_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure_detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure_error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"current_step",
"in_progress",
"failure_detail",
"failure_code",
"failure_error"
]
},
"#/components/schemas/CostPage": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "USD"
},
"estimated": {
"type": "boolean"
},
"hours": {
"type": "number"
},
"copies": {
"type": "integer"
},
"current_usd": {
"type": "string"
},
"monthly_usd": {
"type": "string"
},
"disclaimer": {
"type": "string"
},
"cost_explorer_url": {
"type": [
"string",
"null"
],
"description": "Cost Explorer console URL filtered by user:springwinter:project_id. Null when the project id is blank. Does not call the Cost Explorer API."
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string"
},
"scope": {
"type": "string"
},
"aws_id": {
"type": [
"string",
"null"
]
},
"detail": {
"type": [
"string",
"null"
]
},
"current_usd": {
"type": "string"
},
"monthly_usd": {
"type": "string"
},
"console_url": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"#/components/schemas/MetricsPage": {
"type": "object",
"properties": {
"range": {
"type": "string"
},
"period": {
"type": "integer"
},
"in_progress": {
"type": "boolean"
},
"widgets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"unit": {
"type": "string"
},
"stat": {
"type": "string"
},
"points": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"value": {
"type": [
"number",
"null"
]
}
}
}
}
}
}
}
}
}
}