get_setup_files
Read-only
Get the workspace’s setup files (e.g. .env). Part of Live Preview setup.
UUID
required
Project UUID.
UUID
required
Workspace UUID.
int
default:"0"
Character offset into the response for paging large payloads; use next_offset from the previous call.
update_setup_files
Save the workspace’s setup files (e.g. .env) - used to wire Live Preview.
UUID
required
Project UUID.
UUID
required
Workspace UUID.
array
required
Full set of setup files to save (replaces existing). Each item is {file_path, file_content}, e.g. the project’s .env pointing the front-end at the staging API.
get_preview_proxy_config
Read-only
Get the Live Preview dev-preview proxy config (staging hosts + header rules).
UUID
required
Project UUID.
UUID
required
Workspace UUID.
update_preview_proxy_config
Configure Live Preview: point the app’s API calls at a staging backend.
This is the key Live Preview setup step - it lets the whole app run in Studio
(front-end in the sandbox) while talking to the project’s existing staging
backend. Any user with project access may configure it; gated by the
project_cors_proxy flag in FEI.
UUID
required
Project UUID.
UUID
required
Workspace UUID.
array
required
Upstream backend hosts to proxy the app’s API calls to - i.e. the project’s STAGING backend, e.g. [‘api.staging.example.com’]. This is the core of Live Preview (front-end here, backend at staging).
string
Origin the proxy presents to the backend (Origin/Referer). Use ’${PUBLIC_ORIGIN}’ for auth providers (Clerk/NextAuth) that need it. Omit/null to keep the currently-configured origin (a hosts-only update won’t clear it).