Retrieve enabled feature flags for the provided context.

GET /api/frontend

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.

Request

Responses

• 200
• 401
• 404

---

frontendApiFeaturesSchema

application/json

Schema

Schema

• toggles object[]required

  The actual features returned to the Frontend SDK

  Array [

  name string required

  Unique feature name.

  enabled boolean required

  Always set to true.

  impressionData boolean required

  true if the impression data collection is enabled for the feature, otherwise false.

  variant object

  Variant details

  name string required

  The variants name. Is unique for this feature flag

  enabled boolean required

  Whether the variant is enabled or not.

  payload object

  Extra data configured for this variant

  type string required

  Possible values: [json, csv, string, number]

  The format of the payload.

  value string required

  The payload value stringified.

  feature_enabled boolean

  Whether the feature is enabled or not.

  featureEnabled boolean deprecated

  Use feature_enabled instead.

  ]

Example (from schema)

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

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...