Search the docs

↑↓navigate↵openescclear

Filter by section

7 results for “preview env”

Guides

DeployingPreview environmentsEvery branch and pull request gets its own preview environment with a stable URL. Previews read the preview scope of your environment variables.
DeployingEnvironment variablesSet a value for the preview scope with rivet env set KEY --env preview. Changes apply on the next deploy.
DeployingPreview environmentsProtect previews with a passwordSet PREVIEW_PASSWORD in the preview env scope to put every preview behind basic auth. Production is never affected.

API

POSTREST APIPreviewsCreate a previewPOST /v1/previews builds a branch into a preview environment. Pass env to override preview-scoped variables for this preview only.
GETREST APIEnvironmentList environment variablesGET /v1/projects/{id}/env returns every key with its scopes. Filter with ?scope=preview; secret values are never returned.

Changelog

Changelogv4.2 · Oct 7Preview environments boot in under 3 secondsPreviews resume from a snapshot of the last green build. Opt out with preview.snapshot = false in rivetlane.toml.
Changelogv4.1 · Sep 16Per-preview environment overridesOverride a preview env variable for a single pull request from the dashboard or with rivet env set --preview 482.