Retrieve enabled feature flags for the provided context.

GET 
<your-unleash-url>/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.

Responses

200

frontendApiFeaturesSchema

application/json

Schema

Schema

toggles object[]required
The actual features returned to the Frontend SDK
Array [
namestringrequired
Unique feature name.
Example: disable-comments
enabledbooleanrequired
Always set to true.
Example: true
impressionDatabooleanrequired
true if the impression data collection is enabled for the feature, otherwise false.
Example: false
variant object
Variant details
namestringrequired
The variants name. Is unique for this feature flag
Example: blue_group
enabledbooleanrequired
Whether the variant is enabled or not.
Example: true
payload object
Extra data configured for this variant
typestringrequired
The format of the payload.
Possible values: [json, csv, string, number]
valuestringrequired
The payload value stringified.
feature_enabledboolean
Whether the feature is enabled or not.
Example: true
featureEnabledbooleandeprecated
Use feature_enabled instead.
Example: true
]

Example (auto)

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

401

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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: 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.

Example (auto)

{
  "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."
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/frontend' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

Click the Send API Request button above and see the response here!