# Serverless API Gateway Documentation

## Serverless API Gateway

- [Serverless API Gateway](https://docs.serverlessapigateway.com/readme.md): Open-source API gateway on Cloudflare Workers. Config-driven routing, JWT auth, Auth0, CORS, service binding, and variable mapping at the edge.
- [Introduction](https://docs.serverlessapigateway.com/getting-started/introduction.md): Get started with Serverless API Gateway: clone the repo, install dependencies, configure routes and JWT auth, then deploy to Cloudflare Workers in minutes.
- [Cost](https://docs.serverlessapigateway.com/getting-started/cost.md): Serverless API Gateway pricing and cost estimates. Free tier details and per-request calculations based on Cloudflare Workers usage.
- [Overview](https://docs.serverlessapigateway.com/configuration/overview.md): Complete configuration reference for the Serverless API Gateway. Covers servers, CORS, JWT authorizer, paths, service binding, and wrangler setup.
- [Servers](https://docs.serverlessapigateway.com/configuration/servers.md): Define upstream server aliases and URLs for the Serverless API Gateway. Route API traffic to backend services via config-driven server entries.
- [Service Binding](https://docs.serverlessapigateway.com/configuration/service-binding.md): Configure Cloudflare Workers service bindings in Serverless API Gateway. Bind API routes to Worker services for modular, edge-native serverless integrations.
- [Paths](https://docs.serverlessapigateway.com/configuration/paths.md): Configure path-based API routing in the Serverless API Gateway. Define methods, endpoints, auth, mappings, and server integrations per route.
- [Add and Remove Prefix](https://docs.serverlessapigateway.com/configuration/add-and-remove-prefix.md): Add or remove URL path prefixes when proxying requests in the Serverless API Gateway. Rewrite or strip path segments before forwarding to upstream servers.
- [Authorizer](https://docs.serverlessapigateway.com/configuration/authorizer.md): Configure JWT authorization with HS256 for the Serverless API Gateway. Includes JOSE JWT error codes, claim validation failures, and fixes for common 401 token errors.
- [Authentication](https://docs.serverlessapigateway.com/configuration/authentication.md): Configure API gateway authentication with JWT, Auth0, and Supabase. Supports OAuth 2.0, OTP passwordless login, and token-based auth.
- [CORS](https://docs.serverlessapigateway.com/configuration/cors.md): Configure CORS (Cross-Origin Resource Sharing) for the Serverless API Gateway. Set allowed origins, methods, headers, and preflight cache.
- [Variable Mapping](https://docs.serverlessapigateway.com/configuration/variable-mapping.md): Map and transform request headers, query params, and JWT claims in the Serverless API Gateway. Dynamic variable templates for edge routing.
- [Priority Variables](https://docs.serverlessapigateway.com/configuration/priority-variables.md): Variable resolution priority in Serverless API Gateway mappings. Local config variables override global variables per endpoint.
- [Integrations](https://docs.serverlessapigateway.com/configuration/integrations.md): Serverless API Gateway integrations for authentication, proxying, and service bindings. Connect Auth0, Supabase, HTTP backends, and Cloudflare services.
- [Auth0](https://docs.serverlessapigateway.com/configuration/auth0.md): Configure Auth0 with Serverless API Gateway. Set up Auth0 client ID, client secret, JWKS, callback URLs, and OAuth 2.0 authorization flow.
- [Supabase OTP](https://docs.serverlessapigateway.com/configuration/supabase-otp.md): Supabase OTP for Serverless API Gateway. Fix magic link vs OTP issues, configure signInWithOtp, email templates, phone OTP, and verify flows on Cloudflare Workers.
- [Wrangler](https://docs.serverlessapigateway.com/deployment/wrangler.md): Deploy Serverless API Gateway to Cloudflare Workers using Wrangler CLI. Steps for local dev, environment configs, and production deployment.
- [GitHub Actions](https://docs.serverlessapigateway.com/deployment/github-actions.md): Deploy Serverless API Gateway with GitHub Actions. CI/CD workflow using the serverlessapigateway-action and Cloudflare Wrangler action.
- [Getting Started Guides](https://docs.serverlessapigateway.com/reader-guides/quickstart-first-proxy.md): Build your first HTTP proxy route and confirm that the gateway rewrites and forwards traffic correctly. This guide covers defining a server alias, creating a
- [Quickstart: Health Endpoint](https://docs.serverlessapigateway.com/reader-guides/quickstart-first-proxy/quickstart-health-endpoint.md): Ship a minimal health endpoint before you add upstream integrations so deploys are observable from day one. The config returns a static JSON response with no
- [Quickstart: JWT-Protected Route](https://docs.serverlessapigateway.com/reader-guides/quickstart-first-proxy/quickstart-jwt-protected-route.md): Protect a single route with HS256 JWT validation without forcing authentication on every endpoint. This guide shows how to add an authorizer block and flag
- [Quickstart: Auth0-Protected Route](https://docs.serverlessapigateway.com/reader-guides/quickstart-first-proxy/quickstart-auth0-route.md): Stand up an Auth0-backed route when you need hosted identity and token validation at the edge. This guide covers the authorizer block for Auth0, the callback
- [Quickstart: Supabase Passwordless API](https://docs.serverlessapigateway.com/reader-guides/quickstart-first-proxy/quickstart-supabase-passwordless.md): Use Supabase OTP flows when your product needs passwordless auth routes behind one Worker gateway. This guide covers both the auth request and verify endpoints.
- [Quickstart: Inline Config with SAG\_API\_CONFIG\_JSON](https://docs.serverlessapigateway.com/reader-guides/quickstart-first-proxy/quickstart-inline-config.md): Use inline config for demos, tests, and disposable environments where a separate config file is unnecessary. The entire gateway definition lives in a single
- [Quickstart: KV-Backed Config](https://docs.serverlessapigateway.com/reader-guides/quickstart-first-proxy/quickstart-kv-config.md): 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
- [Routing](https://docs.serverlessapigateway.com/reader-guides/routing-exact-vs-parameter-vs-wildcard.md): Use this page to choose the right route shape and avoid accidental matches when multiple patterns overlap. The gateway evaluates exact paths first, then
- [Routing: ANY Method](https://docs.serverlessapigateway.com/reader-guides/routing-exact-vs-parameter-vs-wildcard/routing-any-method.md): Use ANY when the backend accepts the same behavior for multiple verbs and you want one config entry. This reduces duplication when a single upstream endpoint
- [Routing: Explicit OPTIONS Handlers](https://docs.serverlessapigateway.com/reader-guides/routing-exact-vs-parameter-vs-wildcard/routing-explicit-options-handlers.md): Add explicit OPTIONS routes when a path needs custom preflight behavior instead of the default CORS 204 response. By default, the gateway handles OPTIONS
- [Routing: Prefix Add and Remove](https://docs.serverlessapigateway.com/reader-guides/routing-exact-vs-parameter-vs-wildcard/routing-prefix-add-remove.md): Map public paths to upstream paths cleanly when the origin and public API use different prefixes. The gateway can strip a prefix from the incoming path before
- [Routing: Multiple Upstreams Behind One Domain](https://docs.serverlessapigateway.com/reader-guides/routing-exact-vs-parameter-vs-wildcard/routing-multi-upstream-patterns.md): Split one public API domain across several backends while keeping routing rules readable. Define multiple server aliases in the \`servers\` array and reference
- [Routing: Static Response Routes](https://docs.serverlessapigateway.com/reader-guides/routing-exact-vs-parameter-vs-wildcard/routing-static-response-routes.md): Return fixed JSON or simple values directly from config for health checks and low-risk utility endpoints. Static response routes bypass integration entirely, so
- [Routing: Match Priority Explained](https://docs.serverlessapigateway.com/reader-guides/routing-exact-vs-parameter-vs-wildcard/routing-path-priority-explained.md): Understand why exact matches beat parameterized routes and why parameterized routes beat wildcard routes. The gateway evaluates all defined paths against the
- [Config](https://docs.serverlessapigateway.com/reference/config-schema-overview.md): Use the schema as the contract for valid gateway behavior before you deploy any routing changes. The schema defines every field the gateway accepts, including
- [Config Source: Local File](https://docs.serverlessapigateway.com/reference/config-schema-overview/config-from-local-file.md): Start with a local file when you are iterating in the repo and want simple, inspectable config. The gateway looks for the config file relative to the worker
- [Config Source: Cloudflare KV](https://docs.serverlessapigateway.com/reference/config-schema-overview/config-from-kv.md): Load config from KV when you need runtime-managed routing without baking config into the bundle. This lets you update routing rules, add paths, or change
- [Config Source: SAG\_API\_CONFIG\_JSON](https://docs.serverlessapigateway.com/reference/config-schema-overview/config-from-sag-api-config-json.md): Use the inline JSON env var for tests, previews, and CI flows that need an isolated config payload. The entire config is passed as a single environment
- [Config Validation: Strict Mode](https://docs.serverlessapigateway.com/reference/config-schema-overview/config-strict-mode.md): Enable strict mode when you want invalid config to fail the worker early instead of logging compatibility warnings. In strict mode, any unknown field, type
- [Config Validation: Compatibility Mode](https://docs.serverlessapigateway.com/reference/config-schema-overview/config-compatibility-mode.md): Stay in compatibility mode when you are normalizing legacy config and cannot block traffic on validation warnings yet. Compatibility mode logs warnings for
- [Config Normalization: Legacy Keys](https://docs.serverlessapigateway.com/reference/config-schema-overview/config-legacy-key-normalization.md): Understand how legacy aliases like \`http\` and \`servicesBindings\` are normalized before routing begins. The gateway automatically converts old field names to
- [CORS And Responses](https://docs.serverlessapigateway.com/reference/cors-basics.md): Use the gateway CORS block to centralize browser access policy instead of reimplementing it in every upstream. The CORS config defines which origins, methods,
- [CORS: Credentials and Origins](https://docs.serverlessapigateway.com/reference/cors-basics/cors-credentials-and-origins.md): Set credentials and origins deliberately so browser auth works without opening the API too broadly. When \`allow\_credentials\` is true, the browser requires an
- [CORS: Default Preflight Behavior](https://docs.serverlessapigateway.com/reference/cors-basics/cors-preflight-default-behavior.md): Rely on the built-in 204 preflight response unless a route truly needs a custom OPTIONS handler. The gateway automatically responds to OPTIONS requests using
- [Responses: JSON, String, Boolean, and Null](https://docs.serverlessapigateway.com/reference/cors-basics/response-json-string-boolean-null.md): Use config responses for small, deterministic endpoints where a full proxy or service call adds no value. The \`response\` field in a path entry can be a JSON
- [Responses: Error Shapes](https://docs.serverlessapigateway.com/reference/cors-basics/error-response-shapes.md): Use this page to understand the gateway's JSON error surface before wiring client-side handling. The gateway returns structured JSON errors for 401, 403, 404,
- [Responses: Powered-By Header Behavior](https://docs.serverlessapigateway.com/reference/cors-basics/powered-by-header-behavior.md): Know when the gateway adds its response header so you can reason about downstream caching and observability. The gateway includes a \`powered-by\` header on every
- [Responses: Health, Readiness, and Liveness Patterns](https://docs.serverlessapigateway.com/reference/cors-basics/health-readiness-liveness-patterns.md): Model operational endpoints separately so you can distinguish worker health from upstream dependency health. A health endpoint confirms the worker is running; a
- [Mapping And Variables](https://docs.serverlessapigateway.com/reference/mapping-overview.md): Use mapping when the upstream needs transformed headers or query params rather than the original client request. The mapping block lets you select specific
- [Mapping from Request Headers](https://docs.serverlessapigateway.com/reference/mapping-overview/mapping-request-headers.md): Forward selected request headers to the upstream without exposing the whole client header set. Only headers listed in the \`mapping.headers\` block are sent --
- [Mapping from Request Query Parameters](https://docs.serverlessapigateway.com/reference/mapping-overview/mapping-request-query.md): Promote request query values into stable upstream parameters when you need consistent backend contracts. The \`mapping.query\` block lets you rename, forward, or
- [Mapping from JWT Claims](https://docs.serverlessapigateway.com/reference/mapping-overview/mapping-jwt-claims.md): Inject user or tenant claims into upstream requests after the gateway verifies the token. Any standard or custom JWT claim is available via
- [Mapping: Route Variables vs Global Variables](https://docs.serverlessapigateway.com/reference/mapping-overview/mapping-route-variables-vs-global-variables.md): Use route variables for one-off overrides and global variables for cross-route defaults. Global variables in the top-level \`variables\` block apply to all
- [Environment Variables and Secret Replacement](https://docs.serverlessapigateway.com/reference/mapping-overview/env-and-secret-replacement.md): Replace \`$env.\*\` and \`$secrets.\*\` placeholders at load time so sensitive values stay outside repo config. The gateway resolves these placeholders when it parses
- [Mapping: Debugging Null Values](https://docs.serverlessapigateway.com/reference/mapping-overview/mapping-debugging-null-values.md): Diagnose missing mapped values by checking token claims, request headers, and variable scope order. When a mapped value arrives as null or empty at the
- [Service Execution](https://docs.serverlessapigateway.com/recipes/service-vs-service-binding.md): Choose the right integration type based on whether you need a local module import or a bound Worker method call. The \`service\` type bundles handler code with
- [Service Integrations with Local Entrypoints](https://docs.serverlessapigateway.com/recipes/service-vs-service-binding/service-local-entrypoints.md): Use local services when the gateway and the handler should ship together in one worker project. The \`services\` array defines local module entrypoints that the
- [Service Binding Worker Methods](https://docs.serverlessapigateway.com/recipes/service-vs-service-binding/service-binding-worker-methods.md): Use service bindings when you want worker-to-worker calls through Cloudflare bindings instead of external HTTP. Service bindings provide zero-latency calls
- [Pre-Process Hooks](https://docs.serverlessapigateway.com/recipes/service-vs-service-binding/pre-process-hooks.md): Short-circuit requests before the main integration when policy checks or custom gating logic must run first. The \`pre\_process\` field on a path entry calls a
- [Post-Process Hooks After Auth0 Callback](https://docs.serverlessapigateway.com/recipes/service-vs-service-binding/post-process-hooks-auth0-callback.md): Run post-processing only when the Auth0 callback needs extra side effects after token exchange succeeds. The Auth0 callback integration supports a post-process
- [Worker-to-Worker API Composition](https://docs.serverlessapigateway.com/recipes/service-vs-service-binding/worker-to-worker-api-composition.md): Compose internal Worker services behind one public gateway without turning every call into an external proxy. Service bindings let you build microservice-style
- [Choosing Proxy vs Service Execution](https://docs.serverlessapigateway.com/recipes/service-vs-service-binding/choosing-proxy-vs-service.md): Use this page when you are deciding whether a route should proxy upstream HTTP or execute worker code directly. Proxy routes (\`http\_proxy\`) forward requests to
- [JWT And Security](https://docs.serverlessapigateway.com/security/jwt-hs256-setup.md): Use HS256 JWT auth when you control the signing secret and want simple issuer and audience validation. This guide walks through configuring the authorizer block
- [JWT Issuer and Audience Checks](https://docs.serverlessapigateway.com/security/jwt-hs256-setup/jwt-issuer-and-audience-checks.md): Set issuer and audience correctly so tokens from the wrong tenant or app are rejected at the edge. The gateway compares the \`iss\` and \`aud\` claims in the JWT
- [JWT: Protect Only Selected Routes](https://docs.serverlessapigateway.com/security/jwt-hs256-setup/jwt-protect-only-selected-routes.md): Gate only sensitive endpoints by setting \`auth: true\` where it matters instead of forcing auth on the whole API. The authorizer block configures how tokens are
- [JWT: Common 401 Errors](https://docs.serverlessapigateway.com/security/jwt-hs256-setup/jwt-common-401-errors.md): Debug missing bearer tokens, expired tokens, and invalid claims before blaming the upstream service. The gateway returns specific 401 error messages for each
- [Designing Public vs Private Routes](https://docs.serverlessapigateway.com/security/jwt-hs256-setup/auth-route-design-public-vs-private.md): Separate public and private paths clearly so your API contract stays understandable for clients and maintainers. Group public routes (health, docs, login)
- [Bearer Token Handling](https://docs.serverlessapigateway.com/security/jwt-hs256-setup/auth-bearer-token-handling.md): Use the standard Authorization header format so built-in token extraction works consistently. The gateway expects tokens in the \`Authorization: Bearer \<token>\`
- [Security Limitations and Non-Goals](https://docs.serverlessapigateway.com/security/jwt-hs256-setup/security-limitations-and-non-goals.md): Understand what the gateway does not implement today so you can avoid overclaiming its security surface. The gateway handles JWT validation, issuer/audience
- [Auth0](https://docs.serverlessapigateway.com/integrations/auth0-setup.md): Configure Auth0 when you need hosted identity, JWKS-backed verification, and callback flows at the gateway. This guide covers the full authorizer block,
- [Auth0: JWKS vs JWKS URI](https://docs.serverlessapigateway.com/integrations/auth0-setup/auth0-jwks-vs-jwks-uri.md): Choose local JWKS or remote JWKS URI based on whether you want static config or dynamic key retrieval. A local \`jwks\` object bakes the key set into your config,
- [Auth0 Callback Route](https://docs.serverlessapigateway.com/integrations/auth0-setup/auth0-callback-route.md): Use the callback integration to exchange authorization codes for tokens without moving the flow into your upstream. The gateway handles the code-to-token
- [Auth0 Login Redirect Route](https://docs.serverlessapigateway.com/integrations/auth0-setup/auth0-login-redirect-route.md): Use the redirect integration when the gateway should initiate login instead of the frontend hardcoding the authorize URL. The gateway constructs the Auth0
- [Auth0 Userinfo Route](https://docs.serverlessapigateway.com/integrations/auth0-setup/auth0-userinfo-route.md): Expose a profile endpoint through the gateway when the client needs a normalized entry point for Auth0 user info. The gateway proxies the userinfo request to
- [Auth0 Refresh Token Route](https://docs.serverlessapigateway.com/integrations/auth0-setup/auth0-refresh-token-route.md): Handle refresh token exchange through the gateway when you want one edge-managed auth surface. The gateway sends the refresh token to Auth0's token endpoint and
- [Auth0 Error Handling](https://docs.serverlessapigateway.com/integrations/auth0-setup/auth0-error-handling.md): Use this page to understand upstream, network, and validation errors returned by the Auth0 integration. The gateway surfaces Auth0 API errors, network timeouts,
- [Supabase](https://docs.serverlessapigateway.com/integrations/supabase-jwt-protected-routes.md): Protect routes with Supabase-issued tokens when your app already uses Supabase Auth as the identity provider. The gateway validates Supabase JWTs using the
- [Supabase Email OTP](https://docs.serverlessapigateway.com/integrations/supabase-jwt-protected-routes/supabase-email-otp.md): Use the email OTP integration when you want passwordless email auth behind one edge endpoint. The gateway sends a POST request to Supabase's GoTrue API with the
- [Supabase Phone OTP](https://docs.serverlessapigateway.com/integrations/supabase-jwt-protected-routes/supabase-phone-otp.md): Use the phone OTP integration when your product authenticates users by SMS. The flow is identical to email OTP, but the client sends a phone number instead of
- [Supabase Verify OTP](https://docs.serverlessapigateway.com/integrations/supabase-jwt-protected-routes/supabase-verify-otp.md): Verify OTP codes through the gateway so the client only talks to one auth surface. The client sends the OTP code and the email or phone number to the verify
- [Supabase Alternative Email Auth Path](https://docs.serverlessapigateway.com/integrations/supabase-jwt-protected-routes/supabase-alt-email-auth.md): Use the alternative email path only when the default OTP flow does not match your project behavior. Some Supabase configurations require a different GoTrue
- [Supabase Required Environment Variables](https://docs.serverlessapigateway.com/integrations/supabase-jwt-protected-routes/supabase-required-env-vars.md): Set the required Supabase environment variables before you test any passwordless auth route. The gateway needs \`SUPABASE\_URL\`, \`SUPABASE\_ANON\_KEY\`, and
- [Supabase Troubleshooting: Magic Link vs OTP](https://docs.serverlessapigateway.com/integrations/supabase-jwt-protected-routes/supabase-troubleshooting-magic-link-vs-otp.md): Debug the common mismatch where Supabase sends magic links instead of numeric OTP codes. The gateway's verify integration expects a numeric code, but Supabase
- [Deployment And Troubleshooting](https://docs.serverlessapigateway.com/troubleshooting/wrangler-deploy-guide.md): Use Wrangler for repeatable deployment of the worker, service modules, and bindings configuration. This guide covers the \`wrangler.toml\` fields relevant to the
- [GitHub Actions Deploy Guide](https://docs.serverlessapigateway.com/troubleshooting/wrangler-deploy-guide/github-actions-deploy-guide.md): Automate deploys when you want config and docs checks to run before publishing the worker. This guide covers the GitHub Actions workflow structure, secrets
- [Local Testing with Vitest](https://docs.serverlessapigateway.com/troubleshooting/wrangler-deploy-guide/local-testing-with-vitest.md): Use the existing unit and integration tests as the fastest confidence check for config and routing changes. The gateway repo uses Vitest for unit tests and
- [Local E2E with unstable\_dev](https://docs.serverlessapigateway.com/troubleshooting/wrangler-deploy-guide/local-e2e-with-unstable-dev.md): Run local worker E2E tests when you need real runtime behavior instead of only module-level assertions. The \`unstable\_dev\` API starts a local Wrangler dev
- [Docs Sync and Canonical Examples](https://docs.serverlessapigateway.com/troubleshooting/wrangler-deploy-guide/docs-sync-and-canonical-examples.md): Treat the checked-in config examples as the canonical source for both docs and automated checks. The gateway repo includes config examples that are used in both
- [Debugging Upstream Failures](https://docs.serverlessapigateway.com/troubleshooting/wrangler-deploy-guide/upstream-failure-debugging.md): Use this guide when proxied routes fail and you need to isolate routing, auth, and upstream behavior. Start by checking whether the gateway matched the right
- [Gateway Troubleshooting Matrix](https://docs.serverlessapigateway.com/troubleshooting/wrangler-deploy-guide/gateway-troubleshooting-matrix.md): Use the matrix to map common symptoms to the fastest next diagnostic step. This page lists symptoms like "route returns 404", "auth returns 401", "upstream
- [A](https://docs.serverlessapigateway.com/glossary/a.md): Glossary terms starting with the letter A, covering APIs, authentication, and authorization.
- [API (Application Programming Interface)](https://docs.serverlessapigateway.com/glossary/a/api-application-programming-interface.md): A set of rules and definitions that allows software applications to communicate with each other, enabling the exchange of data and functionality.
- [API Endpoint](https://docs.serverlessapigateway.com/glossary/a/api-endpoint.md): The point at which an API connects with the software program, allowing communication between systems.
- [API Gateway](https://docs.serverlessapigateway.com/glossary/a/api-gateway.md): An API gateway is a server that acts as a single entry point for API requests, handling routing, authentication, and policy enforcement.
- [API Key](https://docs.serverlessapigateway.com/glossary/a/api-key.md): An API key is a unique identifier passed with API requests to authenticate the calling application and control access to services.
- [API Rate Limiting](https://docs.serverlessapigateway.com/glossary/a/api-rate-limiting.md): API rate limiting restricts the number of API requests a client can make within a time frame to protect services and ensure fair access.
- [Asynchronous Operation](https://docs.serverlessapigateway.com/glossary/a/asynchronous-operation.md): Operations that occur without waiting for the previous operation to complete, improving efficiency and performance.
- [Authentication](https://docs.serverlessapigateway.com/glossary/a/authentication.md): The process of verifying the identity of a user or system.
- [Authorization](https://docs.serverlessapigateway.com/glossary/a/authorization.md): The process of verifying what specific applications, files, and data a user has access to.
- [B](https://docs.serverlessapigateway.com/glossary/b.md): Glossary terms starting with the letter B, covering backend services and development blueprints.
- [Backend as a Service (BaaS)](https://docs.serverlessapigateway.com/glossary/b/backend-as-a-service-baas.md): Backend as a Service (BaaS) provides ready-made backend features like databases, auth, and storage so developers can focus on frontend code.
- [Blueprint](https://docs.serverlessapigateway.com/glossary/b/blueprint.md): In API development, a predefined plan or layout for an API's structure and behavior.
- [C](https://docs.serverlessapigateway.com/glossary/c.md): Glossary terms starting with the letter C, covering caching, cloud, containers, and CI/CD.
- [Cache](https://docs.serverlessapigateway.com/glossary/c/cache.md): A hardware or software component that stores data so future requests for that data can be served faster.
- [CDN (Content Delivery Network)](https://docs.serverlessapigateway.com/glossary/c/cdn-content-delivery-network.md): A system of distributed servers that deliver pages and other web content to a user based on the geographic locations of the user, the origin of the webpage, and a content delivery server.
- [CI/CD (Continuous Integration/Continuous Deployment)](https://docs.serverlessapigateway.com/glossary/c/ci-cd-continuous-integration-continuous-deployment.md): A method to frequently deliver apps to customers by introducing automation into the stages of app development.
- [Client](https://docs.serverlessapigateway.com/glossary/c/client.md): The software or device that accesses services or resources on a server.
- [Client-Side Rendering (CSR)](https://docs.serverlessapigateway.com/glossary/c/client-side-rendering-csr.md): Rendering web pages directly in the browser using JavaScript, instead of relying on server-side rendering.
- [Cloud Service Provider (CSP)](https://docs.serverlessapigateway.com/glossary/c/cloud-service-provider-csp.md): A company that offers some component of cloud computing -typically Infrastructure as a Service (IaaS), Software as a Service (SaaS) or Platform as a Service (PaaS)-- to other businesses or individuals
- [Cluster](https://docs.serverlessapigateway.com/glossary/c/cluster.md): A group of servers and other resources that act like a single system and enable high availability and, in some cases, load balancing.
- [Container](https://docs.serverlessapigateway.com/glossary/c/container.md): A lightweight, stand-alone, executable package of software that includes everything needed to run a piece of software, including the code, runtime, libraries, and system settings.
- [Continuous Delivery](https://docs.serverlessapigateway.com/glossary/c/continuous-delivery.md): A software development practice where code changes are automatically built, tested, and prepared for a release to production.
- [Continuous Integration](https://docs.serverlessapigateway.com/glossary/c/continuous-integration.md): A software development practice where developers regularly merge their code changes into a central repository, after which automated builds and tests are run.
- [Cron Job](https://docs.serverlessapigateway.com/glossary/c/cron-job.md): A scheduled task used to automatically execute scripts at specified times and dates.
- [D](https://docs.serverlessapigateway.com/glossary/d.md): Glossary terms starting with the letter D, covering databases, deployment, DevOps, and DNS.
- [Data Lake](https://docs.serverlessapigateway.com/glossary/d/data-lake.md): A storage repository that holds a vast amount of raw data in its native format until it is needed.
- [Data Warehousing](https://docs.serverlessapigateway.com/glossary/d/data-warehousing.md): Electronic storage of a large amount of information by a business, in a manner that is secure, reliable, easy to retrieve, and easy to manage.
- [Database](https://docs.serverlessapigateway.com/glossary/d/database.md): An organized collection of structured information, or data, typically stored electronically in a computer system.
- [Deployment](https://docs.serverlessapigateway.com/glossary/d/deployment.md): The process of making a software application available for use.
- [DevOps](https://docs.serverlessapigateway.com/glossary/d/devops.md): A set of practices that combines software development (Dev) and IT operations (Ops) to shorten the system development life cycle and provide continuous delivery with high software quality.
- [Distributed System](https://docs.serverlessapigateway.com/glossary/d/distributed-system.md): A system whose components are located on different networked computers, which communicate and coordinate their actions by passing messages.
- [DNS (Domain Name System)](https://docs.serverlessapigateway.com/glossary/d/dns-domain-name-system.md): The phonebook of the Internet. Humans access information online through domain names, like nytimes.com or espn.com.
- [Docker](https://docs.serverlessapigateway.com/glossary/d/docker.md): An open platform for developing, shipping, and running applications in containers.
- [Domain](https://docs.serverlessapigateway.com/glossary/d/domain.md): A human-readable address used to identify a website or service on the internet.
- [E](https://docs.serverlessapigateway.com/glossary/e.md): Glossary terms starting with the letter E, covering edge computing, elasticity, and event-driven design.
- [Edge Computing](https://docs.serverlessapigateway.com/glossary/e/edge-computing.md): A distributed computing paradigm that brings computation and data storage closer to the location where it is needed, to improve response times and save bandwidth.
- [Elasticity](https://docs.serverlessapigateway.com/glossary/e/elasticity.md): The ability of a system to automatically scale resources up or down as needed.
- [Endpoint Security](https://docs.serverlessapigateway.com/glossary/e/endpoint-security.md): The practice of securing endpoints or entry points of end-user devices such as desktops, laptops, and mobile devices from being exploited by malicious actors and campaigns.
- [Environment Variables](https://docs.serverlessapigateway.com/glossary/e/environment-variables.md): Key-value pairs in the operating system that are used to store information about the environment that the system is running in.
- [Event-Driven Architecture](https://docs.serverlessapigateway.com/glossary/e/event-driven-architecture.md): A software architecture paradigm promoting the production, detection, consumption of, and reaction to events.
- [F](https://docs.serverlessapigateway.com/glossary/f.md): Glossary terms starting with the letter F, covering FaaS, fault tolerance, and firewalls.
- [Fault Tolerance](https://docs.serverlessapigateway.com/glossary/f/fault-tolerance.md): The ability of a system to continue operating without interruption when one or more of its components fail.
- [Firewall](https://docs.serverlessapigateway.com/glossary/f/firewall.md): A network security device that monitors and filters incoming and outgoing network traffic based on an organization's previously established security policies.
- [Function as a Service (FaaS)](https://docs.serverlessapigateway.com/glossary/f/function-as-a-service-faas.md): Function as a Service (FaaS) is a serverless cloud model that runs individual functions on demand without managing servers.
- [G](https://docs.serverlessapigateway.com/glossary/g.md): Glossary terms starting with the letter G, covering Git version control and GraphQL.
- [Git](https://docs.serverlessapigateway.com/glossary/g/git.md): A distributed version-control system for tracking changes in source code during software development.
- [GraphQL](https://docs.serverlessapigateway.com/glossary/g/graphql.md): A query language for APIs and a runtime for executing those queries by using a type system you define for your data.
- [H](https://docs.serverlessapigateway.com/glossary/h.md): Glossary terms starting with the letter H, covering hashing, high availability, HTTP, and HTTPS.
- [Hashing](https://docs.serverlessapigateway.com/glossary/h/hashing.md): The process of converting a given key into another value. A hash function is used to generate the new value according to a mathematical algorithm.
- [High Availability (HA)](https://docs.serverlessapigateway.com/glossary/h/high-availability-ha.md): A system design approach that ensures a high level of operational uptime and minimal downtime.
- [HTTP (Hypertext Transfer Protocol)](https://docs.serverlessapigateway.com/glossary/h/http-hypertext-transfer-protocol.md): HTTP is the application-layer protocol used for transmitting data on the web, forming the foundation of API communication.
- [HTTPS (Hypertext Transfer Protocol Secure)](https://docs.serverlessapigateway.com/glossary/h/https-hypertext-transfer-protocol-secure.md): An extension of HTTP. It is used for secure communication over a computer network, and is widely used on the Internet.
- [I](https://docs.serverlessapigateway.com/glossary/i.md): Glossary terms starting with the letter I, covering IaaS, IDEs, idempotence, and IoT.
- [Infrastructure as a Service (IaaS)](https://docs.serverlessapigateway.com/glossary/i/infrastructure-as-a-service-iaas.md): A form of cloud computing that provides virtualized computing resources over the internet.
- [J](https://docs.serverlessapigateway.com/glossary/j.md): Glossary terms starting with the letter J, covering the JSON data interchange format.
- [JSON (JavaScript Object Notation)](https://docs.serverlessapigateway.com/glossary/j/json-javascript-object-notation.md): A lightweight data-interchange format that is easy for humans to read and write, and easy for machines to parse and generate.
- [K](https://docs.serverlessapigateway.com/glossary/k.md): Glossary terms starting with the letter K, covering the Kubernetes container orchestration platform.
- [Kubernetes](https://docs.serverlessapigateway.com/glossary/k/kubernetes.md): An open-source system for automating deployment, scaling, and management of containerized applications.
- [L](https://docs.serverlessapigateway.com/glossary/l.md): Glossary terms starting with the letter L, covering latency, load balancing, and logging.
- [Latency](https://docs.serverlessapigateway.com/glossary/l/latency.md): The delay before a transfer of data begins following an instruction for its transfer.
- [Load Balancer](https://docs.serverlessapigateway.com/glossary/l/load-balancer.md): A device that acts as a reverse proxy and distributes network or application traffic across a number of servers.
- [Logging](https://docs.serverlessapigateway.com/glossary/l/logging.md): The process of recording events in a computer system.
- [M](https://docs.serverlessapigateway.com/glossary/m.md): Glossary terms starting with the letter M, covering microservices, middleware, and cloud strategies.
- [Microservices](https://docs.serverlessapigateway.com/glossary/m/microservices.md): An architectural style that structures an application as a collection of loosely coupled, independently deployable services.
- [Middleware](https://docs.serverlessapigateway.com/glossary/m/middleware.md): Software that acts as a bridge between an operating system or database and applications, especially on a network.
- [Migration](https://docs.serverlessapigateway.com/glossary/m/migration.md): The process of moving data, applications, or other business elements from one environment to another.
- [Mocking](https://docs.serverlessapigateway.com/glossary/m/mocking.md): In testing, the practice of simulating the behavior of real modules to achieve a controlled test environment.
- [Monolithic Architecture](https://docs.serverlessapigateway.com/glossary/m/monolithic-architecture.md): A software development model where an application is built as a single and indivisible unit.
- [Multi-Cloud](https://docs.serverlessapigateway.com/glossary/m/multi-cloud.md): Multi-cloud is a strategy that uses services from multiple cloud providers to reduce vendor lock-in and improve resilience.
- [N](https://docs.serverlessapigateway.com/glossary/n.md): Glossary terms starting with the letter N, covering network protocols.
- [Network Protocol](https://docs.serverlessapigateway.com/glossary/n/network-protocol.md): A set of rules that define how data is transmitted over a network.
- [O](https://docs.serverlessapigateway.com/glossary/o.md): Glossary terms starting with the letter O, covering OAuth, object storage, and orchestration.
- [OAuth](https://docs.serverlessapigateway.com/glossary/o/oauth.md): An open standard for access delegation, commonly used as a way for Internet users to grant websites or applications access to their information on other websites but without giving them the passwords.
- [Object Storage](https://docs.serverlessapigateway.com/glossary/o/object-storage.md): A strategy that manages and manipulates data storage as distinct units, called objects. These objects are kept in a single storehouse and are not nested as files in a folder inside other folders.
- [Orchestration](https://docs.serverlessapigateway.com/glossary/o/orchestration.md): Orchestration is the automated coordination of multiple services, tasks, or systems to execute a defined workflow or process.
- [P](https://docs.serverlessapigateway.com/glossary/p.md): Glossary terms starting with the letter P, covering PaaS, payloads, cloud models, and development practices.
- [PaaS (Platform as a Service)](https://docs.serverlessapigateway.com/glossary/p/paas-platform-as-a-service.md): A cloud computing model that provides a complete platform for developing, running, and managing applications without infrastructure complexity.
- [Payload](https://docs.serverlessapigateway.com/glossary/p/payload.md): The part of transmitted data that is the actual intended message.
- [Performance Testing](https://docs.serverlessapigateway.com/glossary/p/performance-testing.md): The process of determining the speed, responsiveness, and stability of a computer, network, software program, or device under a workload.
- [Plugin](https://docs.serverlessapigateway.com/glossary/p/plugin.md): A software component that adds a specific feature to an existing computer program.
- [Private Cloud](https://docs.serverlessapigateway.com/glossary/p/private-cloud.md): A cloud computing model that offers a proprietary environment dedicated to a single business entity.
- [Public Cloud](https://docs.serverlessapigateway.com/glossary/p/public-cloud.md): A cloud computing model that provides services over the public internet and shared across organizations.
- [Pull Request](https://docs.serverlessapigateway.com/glossary/p/pull-request.md): A method of submitting contributions to a development project. It is a request for the project maintainer to pull a branch from a repository, review it, and merge it into the main codebase.
- [Q](https://docs.serverlessapigateway.com/glossary/q.md): Glossary terms starting with the letter Q, covering query languages, query parameters, and queues.
- [Query Language](https://docs.serverlessapigateway.com/glossary/q/query-language.md): A computer language used to make queries into databases and information systems.
- [Query Parameters](https://docs.serverlessapigateway.com/glossary/q/query-parameters.md): Serverless query parameters in Serverless API Gateway. Learn how query strings are forwarded, mapped, validated, and secured in Cloudflare Worker APIs.
- [Queue](https://docs.serverlessapigateway.com/glossary/q/queue.md): A collection of entities that are maintained in a sequence and can be modified by the addition of entities at one end of the sequence and the removal of entities from the other end.
- [R](https://docs.serverlessapigateway.com/glossary/r.md): Glossary terms starting with the letter R, covering rate limiting, REST, and software practices.
- [Rate Limiting](https://docs.serverlessapigateway.com/glossary/r/rate-limiting.md): Rate limiting controls the number of requests a client can make to a server within a given time period to protect against abuse and overload.
- [Real-Time Processing](https://docs.serverlessapigateway.com/glossary/r/real-time-processing.md): The processing of data immediately after capture, without significant delay.
- [Redundancy](https://docs.serverlessapigateway.com/glossary/r/redundancy.md): The duplication of critical components or functions of a system with the intention of increasing reliability of the system.
- [Refactoring](https://docs.serverlessapigateway.com/glossary/r/refactoring.md): The process of restructuring existing computer code--changing the factoring--without changing its external behavior.
- [Regression Testing](https://docs.serverlessapigateway.com/glossary/r/regression-testing.md): A type of software testing that ensures that previously developed and tested software still performs the same way after it is changed or interfaced with other software.
- [Repository](https://docs.serverlessapigateway.com/glossary/r/repository.md): A central place where data is stored and managed.
- [REST (Representational State Transfer)](https://docs.serverlessapigateway.com/glossary/r/rest-representational-state-transfer.md): REST is an architectural style for building web APIs using HTTP methods, stateless communication, and resource-based URLs.
- [Rollback](https://docs.serverlessapigateway.com/glossary/r/rollback.md): The process of reverting a set of changes to a previous state. This is often used in software deployment when a new release causes issues.
- [S](https://docs.serverlessapigateway.com/glossary/s.md): Glossary terms starting with the letter S, covering scalability, security, serverless, and more.
- [SaaS (Software as a Service)](https://docs.serverlessapigateway.com/glossary/s/saas-software-as-a-service.md): SaaS (Software as a Service) is a cloud delivery model where applications are hosted by a provider and accessed by users over the internet.
- [Scalability](https://docs.serverlessapigateway.com/glossary/s/scalability.md): The capability of a system, network, or process to handle a growing amount of work, or its potential to be enlarged to accommodate that growth.
- [Schema](https://docs.serverlessapigateway.com/glossary/s/schema.md): In a database, a schema defines the structure and organization of data. In GraphQL, it specifies the capabilities of the API and how to query it.
- [SDK (Software Development Kit)](https://docs.serverlessapigateway.com/glossary/s/sdk-software-development-kit.md): A collection of software development tools in one installable package. They facilitate the creation of applications by having a compiler, debugger and perhaps a software framework.
- [Service Mesh](https://docs.serverlessapigateway.com/glossary/s/service-mesh.md): A dedicated infrastructure layer built into an app. This invisible layer facilitates service-to-service communications between services or microservices, using a proxy.
- [Session](https://docs.serverlessapigateway.com/glossary/s/session.md): A semi-permanent interactive information interchange, also known as a dialogue, a conversation, or a meeting, between two or more communicating devices, or between a computer and user.
- [SLA (Service Level Agreement)](https://docs.serverlessapigateway.com/glossary/s/sla-service-level-agreement.md): An SLA (Service Level Agreement) is a formal contract defining measurable performance and availability commitments between a service provider and customer.
- [SOAP (Simple Object Access Protocol)](https://docs.serverlessapigateway.com/glossary/s/soap-simple-object-access-protocol.md): SOAP is an XML-based messaging protocol for exchanging structured data between services over HTTP, SMTP, or other transport layers.
- [State](https://docs.serverlessapigateway.com/glossary/s/state.md): In computing, the condition or quality of a computing system as stored in its temporary memory locations or registers.
- [Stateless](https://docs.serverlessapigateway.com/glossary/s/stateless.md): Stateless architecture means each request is independent and self-contained, with no server-side session data stored between requests.
- [Static Site Generator](https://docs.serverlessapigateway.com/glossary/s/static-site-generator.md): A tool that generates a full static HTML website based on raw data and a set of templates.
- [Storage](https://docs.serverlessapigateway.com/glossary/s/storage.md): The retention of retrievable data on a computer or other electronic system.
- [Stress Testing](https://docs.serverlessapigateway.com/glossary/s/stress-testing.md): A form of deliberately intense or thorough testing used to determine the stability of a given system or entity.
- [Swagger (OpenAPI)](https://docs.serverlessapigateway.com/glossary/s/swagger-openapi.md): Swagger/OpenAPI is a specification standard for describing, documenting, and generating client code for RESTful APIs.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.serverlessapigateway.com/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.