Frontend API

Retrieve enabled feature flags for the provided context.

This endpoint returns the list of feature flags that the frontend API evaluates to enabled for the given context. Context values are provided as query parameters. If the Frontend API is disabled 404 is returned.

get/api/frontend

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/frontend
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Response

frontendApiFeaturesSchema

Example response

{
  "toggles": [
    {
      "name": "disable-comments",
      "enabled": true,
      "variant": {
        "name": "blue_group",
        "enabled": true,
        "payload": {
          "type": "json",
          "value": "{\"color\": \"red\"}"
        },
        "feature_enabled": true,
        "featureEnabled": true
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 7 revisions of this API.