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.
GET /api/aws_account
Connected AWS account
{
"tags": [
"AWS"
],
"summary": "Connected AWS account",
"operationId": "getAwsAccount",
"responses": {
"200": {
"description": "Active account for the organization",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"aws_account"
],
"properties": {
"aws_account": {
"$ref": "#/components/schemas/AwsAccount"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "No active account"
}
},
"parameters": []
}
DELETE /api/aws_account
DELETE /api/aws_account
{
"tags": [
"Account"
],
"summary": "DELETE /api/aws_account",
"operationId": "deleteApiAwsAccount",
"responses": {
"204": {
"description": "Connection removed locally; AWS stack stays in customer account"
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "No active account"
},
"422": {
"description": "invalid_csrf_token",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_csrf_token"
]
}
},
"required": [
"error"
]
}
}
}
}
},
"parameters": []
}
POST /api/aws_account/replace_connection
Replace the AWS access role for an active account
Assumes a newly created role in the same AWS account, then updates the existing account record. The current role remains stored if verification fails. The customer creates the CloudFormation stack in AWS.
{
"tags": [
"AWS"
],
"summary": "Replace the AWS access role for an active account",
"description": "Assumes a newly created role in the same AWS account, then updates the existing account record. The current role remains stored if verification fails. The customer creates the CloudFormation stack in AWS.",
"operationId": "replaceAwsAccountConnection",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"aws_account"
],
"properties": {
"aws_account": {
"type": "object",
"required": [
"account_number",
"external_id"
],
"properties": {
"account_number": {
"type": "string",
"pattern": "^[0-9]{12}$"
},
"external_id": {
"type": "string"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "New role verified and saved on the existing account record",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"role_arn",
"aws_account"
],
"properties": {
"role_arn": {
"type": "string"
},
"aws_account": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_number": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidParameters"
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "No active AWS account matches the supplied account number"
},
"422": {
"description": "assume_role_failed; invalid_aws_account; invalid_csrf_token",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"assume_role_failed",
"invalid_aws_account",
"invalid_csrf_token"
]
}
},
"required": [
"error"
]
}
}
}
}
},
"parameters": []
}
GET /api/aws_account/stack_update
Check customer connection stack updates
Compares the installed role template-version tag with the published customer template. Returns current, update_available, or unknown. Does not modify customer infrastructure. Older untagged roles need an update once a versioned template is published.
{
"tags": [
"AWS"
],
"summary": "Check customer connection stack updates",
"description": "Compares the installed role template-version tag with the published customer template. Returns current, update_available, or unknown. Does not modify customer infrastructure. Older untagged roles need an update once a versioned template is published.",
"operationId": "getAwsConnectionStackUpdate",
"responses": {
"200": {
"description": "Safe update status and, when available, AWS console link and public template URL",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"current",
"update_available",
"unknown"
]
},
"installed_version": {
"type": [
"string",
"null"
]
},
"published_version": {
"type": "string"
},
"stack_name": {
"type": "string"
},
"template_url": {
"type": "string",
"format": "uri"
},
"update_url": {
"type": "string",
"format": "uri"
},
"error": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Authentication required"
},
"404": {
"description": "No active AWS connection for this organization"
}
},
"parameters": []
}
POST /api/aws_account/verification
Verify AssumeRole and persist the account
Assumes arn:aws:iam::<account>:role/SpringWinter-<suffix> with the connection external ID. Spring Winter does not CreateStack in the customer account.
{
"tags": [
"AWS"
],
"summary": "Verify AssumeRole and persist the account",
"description": "Assumes `arn:aws:iam::<account>:role/SpringWinter-<suffix>` with the connection external ID. Spring Winter does not CreateStack in the customer account.",
"operationId": "verifyAwsAccount",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"aws_account"
],
"properties": {
"aws_account": {
"type": "object",
"required": [
"account_number",
"external_id"
],
"properties": {
"account_number": {
"type": "string",
"pattern": "^[0-9]{12}$"
},
"external_id": {
"type": "string"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Role assumed and account stored",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"role_arn",
"aws_account"
],
"properties": {
"role_arn": {
"type": "string"
},
"aws_account": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_number": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidParameters"
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"422": {
"description": "assume_role_failed; invalid_aws_account; invalid_csrf_token",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"assume_role_failed",
"invalid_aws_account",
"invalid_csrf_token"
]
}
},
"required": [
"error"
]
}
}
}
}
},
"parameters": []
}
Referenced definitions
These keys resolve the local references in the operations above.{
"#/components/responses/InvalidParameters": {
"description": "Missing or malformed JSON parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "invalid_parameters"
}
}
}
},
"#/components/responses/Unauthenticated": {
"description": "No session cookie",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "unauthenticated"
}
}
}
},
"#/components/schemas/AwsAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"account_number": {
"type": "string"
},
"role_arn": {
"type": "string"
},
"external_id": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"#/components/schemas/Error": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}