PUT
Update static site build and routing configuration

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Path Parameters

uuid
string
required

Static site UUID

Body

application/json

Update static site build and routing configuration

credential_id
string

UUID of stored GitHub App credentials (for a 'github' source)

repository
string

GitHub repository in 'owner/repo' format (for a 'github' source)

branch
string

Branch to build and deploy from (for a 'github' source)

auto_deploy_enabled
boolean

Rebuild and deploy on every push (for a 'github' source)

auto_deploy_branch
string

Branch that triggers auto-deploy (for a 'github' source)

generator
string

Static site generator; 'auto' detects it (for 'git_push' and 'github')

build_command
string

Override the generator's default build command

output_dir
string

Override the generator's default output directory

project_path
string

Subdirectory to build from, for monorepos

spa_mode
boolean

Rewrite unknown paths to /index.html for client-side routing

Response

Update static site build and routing configuration

Api_V1_Entities_StaticSite model

uuid
string
required

Unique static site identifier

name
string
required

The name the site is served under. Unlike applications, no random suffix is appended, so it is the name you sent at creation

label
string
required

Display name

state
string
required

Current state: pending while the bucket and routing are provisioned, assigned once ready, deploying during a deploy, running when live, failed on error

url
string
required

Public URL the site is served on. Custom domains are listed separately

region
string
required

Region the content is stored in. Serving is region-less

project_id
string
required

Associated project UUID

deployment_config
object
required

Content source and build configuration. Bucket credentials are never exposed

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp