latestOpenAPI 3.1.02026-08-1076186318.8 KB

ab648a80ca4d

Static Sites

Update static site basic details

put/static-sites/{id}

Path parameters

idstring uuid required
Example:54fb80af-576c-4fdc-ba4f-b596c83f15a1

Request body

display_namestring
auto_deployboolean
default_branchstring
build_commandstring nullable
node_version'16.20.0' | '18.16.0' | '20.2.0' nullable
published_directorystring nullable

Example request

{
  "display_name": "My static site",
  "auto_deploy": true,
  "default_branch": "main",
  "build_command": "npm run build",
  "node_version": "18.16.0",
  "published_directory": "dist"
}

Response

Static site updated successfully

Example response

{
  "static_site": {
    "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
    "display_name": "My static site",
    "auto_deploy": true,
    "default_branch": "main",
    "build_command": "npm run build",
    "node_version": "20.2.0",
    "published_directory": "dist",
    "updated_at": 1695300630620,
    "status": "deploymentInProgress"
  }
}