DocsPricingBlogSign In
Book Demo
  • Introduction
    • What is Zuplo?
    • Who uses Zuplo, and why?
    • Hosting Options
  • Getting Started
    • Step 1 - Setup Your Gateway
    • Step 2 - Rate Limiting
    • Step 3 - API Key Auth
    • Step 4 - Deploy
    • Bonus - Dynamic Rate Limiting
  • Projects
    • Environment Variables
    • Custom Domains
      • Fastly Setup
  • Deployments
    • Environments
    • Source Control
      • Github Integration
      • BitBucket Integration
      • Gitlab Integration
      • Rename/Move Project
    • Continuous Deployment
      • Custom CI/CD
      • Update API in GitHub Action
    • Observability
      • Metrics Plugins
      • OpenTelemetry Plugin
      • Proactive monitoring
    • Logging
      • Log Plugins
      • VMWare Log Insight
      • Loki Logging
      • Google Cloud Logging
      • Azure Blob
      • Custom Logging Policy
      • Log Export
    • Testing
  • Local Development
    • Quickstart
    • Routes Designer
    • Installing Packages
    • Zuplo Services
    • Debugging
    • Environment variables
    • Typescript Config
    • Troubleshooting
  • Networking & Infrastructure
    • Securing Your Backend
      • GCP Backend with Upstream Auth
      • Secure Tunnel
        • Tunnel Setup & Use
        • Tunnel Troubleshooting
    • Web Application Firewalls
      • Fastly Next-Gen WAF
      • AWS WAF + Shield
    • Cloudflare Settings
  • Monetization
    • Quick Start
      • Step 1 - Set Up Developer Portal
      • Step 2 - Configure Subscription Events
      • Step 3 - Configure Monetization Policy
    • Reference
      • Glossary
      • Programmatic Quotas
      • Stripe Plugin
      • Subscriptions
      • Limitations
  • API Keys
    • Managing Keys
    • Authentication
    • End User Access
    • Using the API
    • React Component
    • Leak Detection
    • Service Limits
    • Buckets & Environments
  • Developer Portal
    • Setup
    • OpenAPI Specifications
    • Authentication
      • Auth0 Setup
      • Clerk Setup
      • Keycloak Setup
      • Supabase Setup
    • Theming
    • Custom Pages
    • Sidebar Configuration
    • Config (dev-portal.json)
    • Create an API Key Consumer on Login
    • Inject Custom Html
  • Policies
    • Authentication
      • API Key Authentication
      • Auth0 JWT Auth
      • Clerk JWT Auth
      • AWS Cognito JWT Auth
      • Firebase JWT Auth
      • Okta JWT Auth
      • JWT Auth
      • PropelAuth JWT Auth
      • Supabase JWT Auth
      • Curity Phantom Token Auth
      • Basic Auth
      • mTLS Auth
      • LDAP Auth
      • HMAC Auth
    • Authorization
      • Okta FGA Authorization
      • OpenFGA Authorization
      • Axiomatics Authorization
      • JWT Scope Validation
      • Access Control List
      • RBAC Authorization
      • Geo-location filtering
      • IP Restriction
    • Security & Validation
      • Rate Limiting
      • Complex Rate Limiting
      • Audit Logs
      • Request Validation
      • Bot Detection
      • Require Origin
      • Request Size Limit
      • Stripe Webhook Auth
    • Metrics, Billing & Quotas
      • Quota
      • Moesif Analytics & Billing
      • Monetization
      • Amberflo Metering / Billing
      • Readme Metrics
    • Testing
      • A/B Test Inbound
      • Mock API Response
      • Sleep / Delay
    • Request Modification
      • Transform Request Body
      • Remove Request Headers
      • Clear Request Headers
      • Change Method
      • Form Data to JSON
      • Remove Query Parameters
      • Add or Set Request Headers
      • Set Body
      • Add or Set Query Parameters
    • Response Modification
      • Transform Response Body
      • Remove Response Headers
      • Clear Response Headers
      • Set Headers
      • Set Status Code
      • XML to JSON Outbound
      • Replace String in Response Body
    • Upstream Authentication
      • Upstream Azure AD Service Auth
      • Upstream GCP Service Auth
      • Upstream GCP Federated Auth
      • Upstream GCP Self-Signed JWT
      • Upstream Firebase Admin Auth
      • Upstream Firebase User Auth
    • Async & Archival
      • Archive Request to Azure Storage
      • Archive Request to GCP Storage
      • Archive Request to AWS S3
      • Archive Response to Azure Storage
      • Archive Response to AWS S3
    • GraphQL
      • GraphQL Disable Introspection
      • GraphQL Complexity Limit
    • Other
      • Composite Inbound (Group Policies)
      • Brown Out
      • Caching
      • Custom Code Inbound
      • Custom Code Outbound
      • Audit Logging
  • Handlers
    • URL Forward
    • URL Rewrite
    • Custom Handler
    • AWS Lambda
    • Redirect
    • OpenAPI Spec Handler
    • Internal Route Handlers
    • WebSocket Handler
  • How to Guides
    • OpenAPI support in Zuplo
    • Versioning on Zuplo
    • Multiple Auth Policies
    • Archiving requests to storage
    • Per user rate-limiting using a database and the ZoneCache
    • Rick and Morty Developer Portal and Documentation
    • How to check an incoming IP address
    • Advanced Path Matching
    • Lazy Load Configuration
    • Handling FormData
    • Testing GraphQL Queries
    • Bypass a Policy
    • Secure your GraphQL API
    • Add Your Zuplo API to Backstage
    • Using the OpenAPI Extension Data in Code
    • Non-Standard Ports
    • Script to Convert URL Params to OpenAPI Format
  • Programming API
    • ZuploRequest
    • ZuploContext
    • ContextData
    • Route Custom Data
    • BackgroundLoader
    • BackgroundDispatcher
    • Web Standard APIs
    • Web Crypto
    • Cache
    • Node Modules
    • Problem Details Helper
    • Code Reuse
    • ZoneCache
    • Key Value Store
    • Zuplo Identity Token
    • Clone Request/Response
    • Runtime Behaviors
    • zp-body-removed
    • Audit Log
    • Request/Response Hooks
    • Custom CORS policies
    • Runtime Extensions
    • Custom Not Found Handler
    • Zuplo Project Config (zuplo.jsonc)
  • Zuplo CLI
    • Installing the Zuplo CLI
    • Analytics
    • Authentication
    • Conversion Commands
    • Deployment Commands
    • Project Commands
    • Test Command
    • Tunnel Commands
    • Environment Variables Commands
    • Local Development Commands
  • Resources
    • Members & Roles
      • Role Permissions
      • Account Members
      • Project Members
    • Account Settings
      • API Keys
      • Billing
    • Single Sign On
      • Okta Setup
      • FAQ
      • Azure AD Setup
    • Platform Limits
    • Errors
    • Security
    • Support
    • Zuplo Developer API
    • Trust & Compliance
    • Changelog

Zuplo Docs

Learn how to use Zuplo to add API-key management, developer documentation, and rate-limiting, for any stack.

OVERVIEW
  • What is Zuplo?
  • Who uses Zuplo, and why?
Getting Started
  • Step 1 - Setup Basic Gateway
  • Step 2 - Rate Limiting
  • Step 3 - API Key Auth
  • Step 4 - Deploying to the Edge