Quick Start
From zero to your first protected API request through EdgeWrap in under 5 minutes. Follow these steps to configure your project via our dashboard and start proxying traffic.
Step 1 — Create a Project
A project represents one API you want to route, protect, and accelerate.
- In the dashboard, click the New Project button.
- Enter a friendly name for your project (e.g.
My Company API). - Enter your Origin URL. This is the public URL of your primary backend API server (e.g.,
https://api.yourcompany.com).
Once created, EdgeWrap assigns you a unique proxy URL (e.g., https://your-project.edgewrap.pro). You will configure your client applications to call this URL.
Step 2 — Configure Your Policies
Configure the services you need by using the dashboard panels. You can enable them with simple toggles:
- Web Application Firewall (WAF): Turn on SQL Injection, XSS, and RCE blocklists under the WAF tab.
- Edge Caching: Configure a default Time-To-Live (TTL) under the Caching tab to cache GET responses close to your users.
- DDoS Protection: Configure IP-based rate limiting thresholds to prevent burst traffic from overwhelming your origin.
Step 3 — Generate a Server API Key
EdgeWrap requires a valid Server API Key for every request. You create this from the dashboard — there is no login or signup API.
- Navigate to the API Keys tab inside your dashboard project view.
- Click Create API Key and select the Server platform type.
- Give the key a descriptive name (e.g.
Production Server). - Click Generate and copy your new Server API Key (e.g.,
ek_live_xxxxxxxxxxxx).
Step 4 — Route Client Requests
Change the base URL of your client applications from your old origin URL (https://api.yourcompany.com) to your project's new EdgeWrap proxy URL (https://your-project.edgewrap.pro).
Attach the generated API key as the x-api-key header with every request.
curl https://your-project.edgewrap.pro/v1/users \
-H "x-api-key: ek_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"