Quickstart: Inline Config with SAG_API_CONFIG_JSON
Use inline config for demos, tests, and disposable environments where a separate config file is unnecessary. The entire gateway definition lives in a single
Last updated
Use inline config for demos, tests, and disposable environments where a separate config file is unnecessary. The entire gateway definition lives in a single
Use inline config for demos, tests, and disposable environments where a separate config file is unnecessary. The entire gateway definition lives in a single environment variable, which the worker reads at startup. This approach is useful for CI pipelines and preview deployments where you generate config dynamically.
Last reviewed: 2026-03-06
Use these quickstart guides when you are setting up Serverless API Gateway for the first time or adding a new integration pattern. Each guide walks through one isolated concern so you can deploy incrementally instead of configuring everything at once.
Every quickstart produces a deployable wrangler.toml and JSON config pair -- you can run wrangler deploy at the end of each guide.
Guides are ordered from simplest (health endpoint) to most complex (Auth0/Supabase passwordless), so earlier guides serve as prerequisites for later ones.
Config can come from a local file, Cloudflare KV, or the SAG_API_CONFIG_JSON environment variable -- choose based on your deploy workflow.
All guides use the same JSON config schema, so patterns you learn in one guide transfer directly to others.
export SAG_API_CONFIG_JSON='{"paths":[{"method":"GET","path":"/health","response":{"status":"ok"}}]}'
wrangler deployThis snippet shows how to export the full JSON config as the SAG_API_CONFIG_JSON environment variable and deploy with Wrangler. The gateway reads this variable at startup when no local config file or KV binding is found.
If wrangler deploy fails with a config error, validate your JSON against the schema file (api-config.schema.json) before investigating further.
If the health endpoint returns 404, confirm that your wrangler.toml points to the correct main entrypoint and that the config file is being loaded.
If JWT or Auth0 routes return 500, check that all required environment variables and secrets are set in your Cloudflare dashboard or .dev.vars file.
Use wrangler tail to stream live logs from the deployed worker and see the exact error message the gateway produces.
Last updated