Unleash Edge API overview

View as Markdown
Enterprise

Unleash Edge sits between your applications and your Unleash instance, exposing endpoints that are compatible with the Client API and the Frontend API. SDKs connect to Edge instead of connecting directly to Unleash, which reduces latency and offloads traffic from your main instance.

Base paths:

  • Client API endpoints: <your-edge-url>/api/client
  • Frontend API endpoints: <your-edge-url>/api/frontend

Primary use: Serve cached flag configurations to backend SDKs for server-side evaluation, and evaluate flags on the Edge node for frontend SDKs without sending user data upstream.

Because the endpoints are API-compatible, you don’t need to change your SDK code to use Edge: point the SDK at your Edge URL instead of your Unleash URL.

Authentication

Use backend tokens for Client API endpoints and frontend tokens for Frontend API endpoints. In edge mode, Edge validates standard tokens against your upstream Unleash instance, so the tokens must exist there; pre-trusted tokens are the exception. In offline mode, Edge validates requests against the client and frontend tokens configured at startup, which do not need to exist in Unleash.

Available endpoints

Client API endpoints

Backend SDKs use these endpoints to fetch complete flag configurations for server-side evaluation.

EndpointMethodDescription
/api/client/featuresGET/POSTFetch all feature flags and configurations from the Edge cache.
/api/client/features/{feature_name}GETFetch a single feature flag configuration.
/api/client/metricsPOSTReport flag usage metrics.
/api/client/metrics/bulkPOSTReport metrics in bulk, for example from a daisy-chained Edge instance.
/api/client/registerPOSTRegister an SDK instance.

Frontend API endpoints

Frontend SDKs use these endpoints to fetch flags that Edge evaluates for a specific Unleash Context.

EndpointMethodDescription
/api/frontendGET/POSTFetch enabled feature flags for the provided context.
/api/frontend/allGET/POSTFetch all feature flags for the provided context, including disabled ones.
/api/frontend/features/{feature_name}GET/POSTFetch a single evaluated feature flag for the provided context.
/api/frontend/client/metricsPOSTReport usage metrics.
/api/frontend/client/registerPOSTRegister an SDK instance.

The Unleash Edge API documents the endpoints that Edge exposes to your SDKs. These are different from the endpoints that Edge calls back to your Unleash instance, such as token validation and metrics ingestion. Those endpoints live on your Unleash server and appear under the Unleash Edge section of the Admin API, for example Register Edge observability metrics.

Deploy and configure Edge

To learn how Edge works and how to run it, see: