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.
{
"tags": [
"Static websites"
],
"summary": "Launch a static website",
"description": "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.",
"operationId": "createStaticWebsite",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"static_website"
],
"properties": {
"static_website": {
"type": "object",
"required": [
"name",
"repository",
"build_command",
"output_directory",
"spa_rewrite"
],
"properties": {
"name": {
"type": "string"
},
"repository": {
"type": "string",
"example": "acme/docs"
},
"build_command": {
"type": "string",
"example": "npm ci && npm run build"
},
"output_directory": {
"type": "string",
"example": "dist"
},
"spa_rewrite": {
"type": "boolean",
"example": true
},
"build_variables": {
"type": "array",
"maxItems": 50,
"description": "Initial build-time variables. Values are transferred through a temporary customer Secrets Manager secret to CodeBuild. They may be embedded in public output. Static sites do not use a Dockerfile.",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
}
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Resource accepted; workflow started. This does not confirm deployment or teardown completion. Poll the resource GET and inspect workflow status until succeeded or failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticWebsiteContractMutation"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidParameters"
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"initial_build_environment_unavailable",
"invalid_static_website",
"missing_aws_account",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
GET /api/projects/{project_id}/static_websites/{id}
Show a static website
{
"tags": [
"Static websites"
],
"summary": "Show a static website",
"operationId": "getStaticWebsite",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"responses": {
"200": {
"description": "Resource and asynchronous workflow history. A public URL alone does not prove a successful deployment.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticWebsiteContractShow"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
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.
{
"tags": [
"Static websites"
],
"summary": "Update build settings or auto-deploy",
"description": "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.",
"operationId": "updateStaticWebsite",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"static_website"
],
"properties": {
"static_website": {
"type": "object",
"minProperties": 1,
"properties": {
"build_command": {
"type": "string"
},
"output_directory": {
"type": "string"
},
"spa_rewrite": {
"type": "boolean"
},
"deploy_branch_pattern": {
"type": "string",
"description": "Branch regex for GitHub push auto-deploy. Blank disables it."
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Desired configuration saved. No deployment workflow starts; redeploy to apply saved settings.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/StaticWebsiteContractResource"
}
},
"required": [
"resource"
]
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidParameters"
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_static_website"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
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.
{
"tags": [
"Static websites"
],
"summary": "Tear down a static website",
"description": "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.",
"operationId": "deleteStaticWebsite",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"responses": {
"202": {
"description": "Resource accepted; workflow started. This does not confirm deployment or teardown completion. Poll the resource GET and inspect workflow status until succeeded or failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticWebsiteContractMutation"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"previews_exist",
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_static_website",
"missing_aws_account",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
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.
{
"tags": [
"Static websites"
],
"summary": "Update build settings or auto-deploy",
"description": "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.",
"operationId": "replaceStaticWebsite",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"static_website"
],
"properties": {
"static_website": {
"type": "object",
"minProperties": 1,
"properties": {
"build_command": {
"type": "string"
},
"output_directory": {
"type": "string"
},
"spa_rewrite": {
"type": "boolean"
},
"deploy_branch_pattern": {
"type": "string",
"description": "Branch regex for GitHub push auto-deploy. Blank disables it."
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Desired configuration saved. No deployment workflow starts; redeploy to apply saved settings.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/StaticWebsiteContractResource"
}
},
"required": [
"resource"
]
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidParameters"
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_static_website"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
GET /api/projects/{project_id}/static_websites/{id}/cost
Static website cost estimate
{
"tags": [
"Static websites"
],
"summary": "Static website cost estimate",
"operationId": "getStaticWebsiteCost",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"responses": {
"200": {
"description": "Catalog cost estimate with cost_explorer_url",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostPage"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
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.
{
"tags": [
"Static websites"
],
"summary": "Read static website environment variables",
"operationId": "getStaticWebsiteEnvironment",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"name": "scope",
"in": "query",
"schema": {
"type": "string",
"enum": [
"build"
]
}
}
],
"responses": {
"200": {
"description": "CodeBuild project variables (build-time). Reserved names are omitted.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentPage"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"aws_credentials_invalid",
"environment_unavailable",
"invalid_environment",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
},
"description": "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.
{
"tags": [
"Static websites"
],
"summary": "Replace static website environment variables",
"description": "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.",
"operationId": "updateStaticWebsiteEnvironment",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"environment"
],
"properties": {
"environment": {
"type": "object",
"properties": {
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
},
"description": "Full replacement list. Omitted variables is treated as [], clearing user variables."
},
"scope": {
"type": "string",
"enum": [
"build"
]
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Updated environment variables",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentPage"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"aws_credentials_invalid",
"environment_unavailable",
"invalid_static_website",
"missing_aws_account",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
GET /api/projects/{project_id}/static_websites/{id}/logs
Static website logs
CodeBuild output only (source=build).
{
"tags": [
"Static websites"
],
"summary": "Static website logs",
"description": "CodeBuild output only (`source=build`).",
"operationId": "getStaticWebsiteLogs",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"name": "source",
"in": "query",
"schema": {
"type": "string",
"enum": [
"build"
]
}
},
{
"name": "run_id",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "next_token",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Log events",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogPage"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"aws_credentials_invalid",
"missing_permissions",
"unsupported_log_source"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
GET /api/projects/{project_id}/static_websites/{id}/metrics
Static website metrics
CloudFront request, 4xx, and 5xx widgets.
{
"tags": [
"Static websites"
],
"summary": "Static website metrics",
"description": "CloudFront request, 4xx, and 5xx widgets.",
"operationId": "getStaticWebsiteMetrics",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"name": "range",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Metric widgets",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsPage"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"aws_credentials_invalid",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
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.
{
"tags": [
"Static websites"
],
"summary": "Create a preview of a static website",
"description": "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.",
"operationId": "createStaticWebsitePreview",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"preview": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"branch",
"commit"
]
},
"branch": {
"type": "string"
},
"git_sha": {
"type": "string"
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
},
"description": "Optional full initial environment override. Omitted copies parent variables; [] uses no variables."
}
},
"required": [
"source"
],
"oneOf": [
{
"properties": {
"source": {
"const": "branch"
}
},
"required": [
"branch"
]
},
{
"properties": {
"source": {
"const": "commit"
}
},
"required": [
"git_sha"
]
}
]
}
},
"required": [
"preview"
]
}
}
}
},
"responses": {
"201": {
"description": "Preview created and workflow started; deployment is asynchronous.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/ComputePreviewResource"
},
"workflow_run_id": {
"type": "string"
},
"preview": {
"$ref": "#/components/schemas/ComputePreview"
}
},
"required": [
"resource",
"workflow_run_id",
"preview"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_git_ref",
"invalid_preview",
"missing_aws_account",
"missing_permissions",
"no_previous_deployment"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
GET /api/projects/{project_id}/static_websites/{id}/previews/{preview_id}
Show a static website preview
{
"tags": [
"Static websites"
],
"summary": "Show a static website preview",
"operationId": "getStaticWebsitePreview",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"$ref": "#/components/parameters/PreviewId"
}
],
"responses": {
"200": {
"description": "Preview and workflow state",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"preview": {
"$ref": "#/components/schemas/ComputePreview"
}
},
"required": [
"preview"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"preview_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
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.
{
"tags": [
"Static websites"
],
"summary": "Tear down a static website preview",
"operationId": "deleteStaticWebsitePreview",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"$ref": "#/components/parameters/PreviewId"
}
],
"responses": {
"202": {
"description": "Preview workflow started; completion is asynchronous.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/ComputePreviewResource"
},
"workflow_run_id": {
"type": "string"
}
},
"required": [
"resource",
"workflow_run_id"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"preview_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_preview",
"missing_aws_account",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
},
"description": " 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.
{
"tags": [
"Static Websites"
],
"summary": "Environment preview",
"operationId": "environmentStaticWebsitePreview",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"$ref": "#/components/parameters/PreviewId"
},
{
"name": "scope",
"in": "query",
"schema": {
"type": "string",
"enum": [
"build"
]
}
}
],
"responses": {
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"preview_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"aws_credentials_invalid",
"environment_unavailable",
"invalid_environment",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"200": {
"description": "CodeBuild project variables (build-time). Reserved names are omitted.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentPage"
}
}
}
}
},
"description": "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.
{
"tags": [
"Static Websites"
],
"summary": "Update Environment preview",
"operationId": "update_environmentStaticWebsitePreview",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"$ref": "#/components/parameters/PreviewId"
}
],
"responses": {
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"preview_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"aws_credentials_invalid",
"environment_unavailable",
"invalid_environment",
"missing_aws_account",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"200": {
"description": "Updated environment variables",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentPage"
}
}
}
}
},
"description": "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.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"environment"
],
"properties": {
"environment": {
"type": "object",
"properties": {
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
},
"description": "Full replacement list. Omitted variables is treated as [], clearing user variables."
},
"scope": {
"type": "string",
"enum": [
"build"
]
}
}
}
}
}
}
}
}
}
GET /api/projects/{project_id}/static_websites/{id}/previews/{preview_id}/logs
Logs preview
{
"tags": [
"Static Websites"
],
"summary": "Logs preview",
"operationId": "logsStaticWebsitePreview",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"$ref": "#/components/parameters/PreviewId"
},
{
"name": "source",
"in": "query",
"schema": {
"type": "string",
"enum": [
"build"
]
}
},
{
"name": "run_id",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "next_token",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"preview_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"aws_credentials_invalid",
"missing_permissions",
"unsupported_log_source"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"200": {
"description": "Preview observations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogPage"
}
}
}
}
}
}
GET /api/projects/{project_id}/static_websites/{id}/previews/{preview_id}/metrics
Metrics preview
{
"tags": [
"Static Websites"
],
"summary": "Metrics preview",
"operationId": "metricsStaticWebsitePreview",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"$ref": "#/components/parameters/PreviewId"
},
{
"name": "range",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"preview_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"aws_credentials_invalid",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"200": {
"description": "Preview observations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsPage"
}
}
}
}
}
}
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.
{
"tags": [
"Static Websites"
],
"summary": "Redeploy preview",
"operationId": "redeployStaticWebsitePreview",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
},
{
"$ref": "#/components/parameters/PreviewId"
}
],
"responses": {
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"preview_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_preview",
"missing_aws_account",
"missing_permissions",
"no_previous_deployment"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"202": {
"description": "Preview workflow started; completion is asynchronous.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/ComputePreviewResource"
},
"workflow_run_id": {
"type": "string"
}
},
"required": [
"resource",
"workflow_run_id"
]
}
}
}
}
},
"description": " 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.
{
"tags": [
"Static websites"
],
"summary": "Redeploy a static website",
"description": "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.",
"operationId": "redeployStaticWebsite",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"redeploy": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"existing",
"branch",
"commit"
]
},
"branch": {
"type": "string"
},
"git_sha": {
"type": "string"
}
}
}
}
}
}
}
},
"responses": {
"202": {
"description": "Resource accepted; workflow started. This does not confirm deployment or teardown completion. Poll the resource GET and inspect workflow status until succeeded or failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticWebsiteContractMutation"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"409": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_git_ref",
"invalid_static_website",
"missing_aws_account",
"missing_permissions",
"no_previous_deployment"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
}
}
}
GET /api/projects/{project_id}/static_websites/{id}/screenshot
Screenshot static website
{
"tags": [
"Static Websites"
],
"summary": "Screenshot static website",
"operationId": "screenshotStaticWebsite",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
},
{
"$ref": "#/components/parameters/StaticWebsiteId"
}
],
"responses": {
"404": {
"description": "Request rejected. See error code.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found",
"screenshot_not_found",
"static_website_not_found"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Present for missing_permissions."
}
},
"required": [
"error"
]
}
}
}
},
"200": {
"description": "Latest ready production screenshot",
"headers": {
"Cache-Control": {
"schema": {
"type": "string"
},
"example": "private, max-age=300"
}
},
"content": {
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
Referenced definitions
These keys resolve the local references in the operations above.{
"#/components/parameters/PreviewId": {
"name": "preview_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"#/components/parameters/ProjectIdInPath": {
"name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"#/components/parameters/StaticWebsiteId": {
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"#/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/ComputePreview": {
"type": "object",
"required": [
"id",
"status"
],
"properties": {
"id": {
"type": "string"
},
"branch": {
"type": [
"string",
"null"
]
},
"git_sha": {
"type": [
"string",
"null"
]
},
"commit_url": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"deploying",
"live",
"failed",
"deleting"
]
},
"public_url": {
"type": [
"string",
"null"
]
},
"alias_url": {
"type": [
"string",
"null"
]
},
"is_alias_head": {
"type": "boolean"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"workflow_run": {
"anyOf": [
{
"$ref": "#/components/schemas/ComputeWorkflowRun"
},
{
"type": "null"
}
]
},
"teardown_run": {
"anyOf": [
{
"$ref": "#/components/schemas/ComputeWorkflowRun"
},
{
"type": "null"
}
]
}
}
},
"#/components/schemas/ComputePreviewResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"example": "web_server"
},
"status": {
"type": "string"
},
"container_port": {
"type": [
"integer",
"null"
]
},
"health_path": {
"type": [
"string",
"null"
]
},
"vcpu": {
"type": [
"number",
"null"
]
},
"memory_gb": {
"type": [
"number",
"null"
]
},
"min_copies": {
"type": [
"integer",
"null"
]
},
"max_copies": {
"type": [
"integer",
"null"
]
},
"deploy_branch_pattern": {
"type": [
"string",
"null"
]
}
}
},
"#/components/schemas/ComputeWorkflowRun": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending",
"running",
"succeeded",
"failed"
]
},
"current_step": {
"type": [
"string",
"null"
]
},
"in_progress": {
"type": "boolean"
},
"repository": {
"type": [
"string",
"null"
]
},
"git_sha": {
"type": [
"string",
"null"
]
},
"commit_url": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"started_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"finished_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"build_started": {
"type": "boolean"
},
"failure_detail": {
"type": [
"string",
"null"
]
},
"failure_code": {
"type": [
"string",
"null"
]
},
"failure_error": {
"type": [
"string",
"null"
]
}
}
},
"#/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/EnvironmentPage": {
"type": "object",
"required": [
"variables"
],
"properties": {
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
}
}
}
},
"#/components/schemas/EnvironmentVariable": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"#/components/schemas/Error": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"#/components/schemas/LogPage": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"build",
"server"
]
},
"workflow_run_id": {
"type": [
"string",
"null"
]
},
"group": {
"type": [
"string",
"null"
]
},
"stream": {
"type": [
"string",
"null"
]
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"next_token": {
"type": [
"string",
"null"
]
},
"in_progress": {
"type": "boolean"
},
"console_url": {
"type": [
"string",
"null"
],
"description": "CloudWatch Logs Insights console URL for this log group in the project region. Null when group or region is blank. Does not call the Logs Insights API."
}
}
},
"#/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"
]
}
}
}
}
}
}
}
}
},
"#/components/schemas/StaticWebsiteContractMutation": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/StaticWebsiteContractResource"
},
"workflow_run_id": {
"type": "string"
}
},
"required": [
"resource",
"workflow_run_id"
]
},
"#/components/schemas/StaticWebsiteContractResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"const": "static_website"
},
"status": {
"type": "string",
"enum": [
"pending",
"active",
"suspended"
]
},
"build_command": {
"type": [
"string",
"null"
]
},
"output_directory": {
"type": [
"string",
"null"
]
},
"spa_rewrite": {
"type": "boolean"
},
"deploy_branch_pattern": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"kind",
"status",
"build_command",
"output_directory",
"spa_rewrite",
"deploy_branch_pattern"
]
},
"#/components/schemas/StaticWebsiteContractShow": {
"type": "object",
"properties": {
"resource": {
"$ref": "#/components/schemas/StaticWebsiteContractResource"
},
"workflow_run": {
"anyOf": [
{
"$ref": "#/components/schemas/ComputeWorkflowRun"
},
{
"type": "null"
}
]
},
"workflow_runs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComputeWorkflowRun"
}
},
"teardown_run": {
"anyOf": [
{
"$ref": "#/components/schemas/ComputeWorkflowRun"
},
{
"type": "null"
}
]
},
"public_url": {
"type": [
"string",
"null"
]
},
"previews": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComputePreview"
}
},
"screenshot": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"captured_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"width": {
"type": [
"integer",
"null"
]
},
"height": {
"type": [
"integer",
"null"
]
}
}
},
{
"type": "null"
}
]
}
},
"required": [
"resource",
"workflow_run",
"workflow_runs",
"teardown_run",
"public_url",
"previews",
"screenshot"
]
}
}