2.4 KiB
id | title |
---|---|
features | /api/client/features |
Fetching Feature Toggles
GET: http://unleash.host.com/api/client/features
HEADERS:
- UNLEASH-APPNAME: appName
- UNLEASH-INSTANCEID: instanceId
This endpoint is the one all clients should use to fetch all available feature toggles from the unleash-server. The response returns all active feature toggles and their current strategy configuration. A feature toggle will have at least one configured strategy. A strategy will have a name
and parameters
map.
Note: Clients should prefer the
strategies
property. Legacy properties (strategy
¶meters
) will be kept until version 2 of the format.
This endpoint should never return anything besides a valid 20X or 304-response. It will also include an Etag
-header. The value of this header can be used by clients as the value of the If-None-Match
-header in the request to prevent a data transfer if the client already has the latest response locally.
Example response:
{
"version": 1,
"features": [
{
"name": "Feature.A",
"description": "lorem ipsum",
"enabled": false,
"strategies": [
{
"name": "default",
"parameters": {}
}
],
"strategy": "default",
"parameters": {}
},
{
"name": "Feature.B",
"description": "lorem ipsum",
"enabled": true,
"strategies": [
{
"name": "ActiveForUserWithId",
"parameters": {
"userIdList": "123,221,998"
}
},
{
"name": "GradualRolloutRandom",
"parameters": {
"percentage": "10"
}
}
],
"strategy": "ActiveForUserWithId",
"parameters": {
"userIdList": "123,221,998"
}
}
]
}
You may limit the response by sending a namePrefix
query-parameter.
GET: http://unleash.host.com/api/client/features/:featureName
Used to fetch details about a specific feature toggle. This is mainly provided to make it easy to debug the API and should not be used by the client implementations.
Notice: You will not get a version property when fetching a specific feature toggle by name.
{
"name": "Feature.A",
"description": "lorem ipsum..",
"enabled": false,
"strategies": [
{
"name": "default",
"parameters": {}
}
],
"strategy": "default",
"parameters": {}
}