For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quickstart: KV-Backed Config

Move config into Cloudflare KV when you want the gateway to load its routing definition at runtime. This decouples config updates from worker deploys, so you

Move config into Cloudflare KV when you want the gateway to load its routing definition at runtime. This decouples config updates from worker deploys, so you can change routes without redeploying the worker. Use this when your operations team needs to update routing independently.

Last reviewed: 2026-03-06

When to use this

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.

Key concepts

  • 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.

Repo-grounded example

wrangler kv:key put --binding=CONFIG api-config.json ./src/api-config.json
wrangler deploy

This snippet uses the Wrangler CLI to write the local JSON config file into a KV namespace bound as CONFIG. The gateway reads the api-config.json key from KV at startup and falls back to other sources if the key is missing.

Troubleshooting

  • 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