Getting Started

From zero to your first proxied request in under 2 minutes. Nolxy acts as a secure gateway between your consumers and your backend APIs.

How Nolxy Works

Consumer
Nolxy Gateway
Your Backend

Requests hit Nolxy first. Nolxy authenticates, rate-limits, caches, logs, and proxies them to your upstream service.

1Create an Account

Sign up for a Nolxy account. You start on the Free plan (10K requests/month, 5 API keys, 10 routes) — no credit card required.

After registration, you will receive a User Hash — a unique public identifier used in your proxy URL. Find it on your Dashboard Overview.

2Create a Route

A Route maps a public path on Nolxy to your real backend URL. All traffic matching that path is forwarded upstream.

  1. Go to Dashboard → Routes
  2. Click Create Route
  3. Path: /todos — the public endpoint consumers will call
  4. Target URL: https://jsonplaceholder.typicode.com — your upstream API
  5. Methods: Select allowed HTTP methods (GET, POST, etc.)
  6. Click Create

Route features

Each route can independently enable response caching, circuit breaker, automatic retries, CORS, request transformations, and a backend secret header. Configure these after creation.

3Generate an API Key

Every proxy request must include a valid API key in the x-nolxy-api-key header. Keys are SHA-256 hashed — Nolxy never stores them in plaintext.

  1. Go to Dashboard → API Keys
  2. Click Generate Key
  3. Name it (e.g., "Development") and click Create
  4. Copy the key immediately — it is shown only once

You can optionally set IP restrictions, an expiration date, and allowed routes per key from the Security Rules page.

4Make Your First Request

Call your API through the Nolxy proxy:

bash
curl http://localhost:3030/proxy/todos \
  -H "x-nolxy-api-key: YOUR_API_KEY"

URL structure: {host}/proxy/{routePath}

  • YOUR_USER_HASH — found on your Dashboard Overview
  • /todos — the route path you created in step 2
  • x-nolxy-api-key — the key from step 3

5Verify in Dashboard

After making requests, verify everything is working:

Analytics

Check Analytics for request counts, latency, and status codes

Usage

Check Usage to see quota consumption against your plan limits

Next Steps

Routes & Proxying