← Gatekeeper

Documentation

Need help? Contact support →

REST gateway

/api/gw/:service/:path*

Register a public HTTPS upstream in an instance's REST tab with a base URL, authentication header, secret, and optional monthly request quota. Gatekeeper encrypts the secret and injects it only on the upstream request.

GET https://gatekeeper.nexteraconsult.com/api/gw/weather/forecast?city=Chicago
X-API-Key: gk_live_...
X-App-ID: APP_...

Safety model

  • Only configured, active services for the calling instance are reachable.
  • Only GET, POST, PUT, PATCH, and DELETE are handled; request and response bodies are limited to 10 MB.
  • HTTPS is required; non-public IPs and DNS results are rejected, and the validated public address is used for the connection.
  • Gatekeeper authentication headers and cookies are never forwarded upstream.
  • Request metadata—not request or response bodies—is logged when the gateway reaches its logging step. REST request logs are operator-only and are not currently visible in the customer dashboard.
  • Monthly quotas count valid requests admitted for upstream forwarding, including upstream failures; a quota-store error returns 503 and temporarily blocks calls.
  • Per-minute rate checks fail open during Upstash outages.