Update one or more properties of an existing static site. Only include the fields you want to change - omitted fields are left unchanged. Changes to build settings take effect on the next deployment.
API key authentication. Pass your API key as a Bearer token in the Authorization header.
Static site identifier
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Human-readable name shown in the dashboard and API responses
1 - 64"My Static Site"
Enable or disable automatic deployments on every push to the default branch
true
Git branch used for automatic and manual deployments when no branch is explicitly specified
1"main"
Command used to build the static site
"npm run build"
Node.js version used to build the static site
"20"
Directory containing the built files to publish
"dist"
Enable or disable preview deployments for pull requests targeting the default branch
false
Default Response
Unique identifier for the static site
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Human-readable name shown in the dashboard and API responses
"My Static Site"
When enabled, a new deployment is automatically triggered on every push to the default branch
true
Git branch used for automatic and manual deployments when no branch is explicitly specified
"main"
Command used to build the static site
"npm run build"
Node.js version used to build the static site
"20"
Directory containing the built files to publish
"dist"
When enabled, preview deployments are created for pull requests targeting the default branch
false
Timestamp when the static site was last modified, in ISO 8601 format
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$"2025-01-30T00:00:00.000Z"
Current status of the static site reflecting the most recent deployment or lifecycle operation
deploymentInProgress, deploymentFailed, deploymentSuccess, deploymentCancelled, deleting, deletionFailed "deploymentSuccess"