mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
90 lines
2.4 KiB
Markdown
90 lines
2.4 KiB
Markdown
---
|
|
id: features
|
|
title: /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` & `parameters`) 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:**
|
|
|
|
```json
|
|
{
|
|
"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.
|
|
|
|
```json
|
|
{
|
|
"name": "Feature.A",
|
|
"description": "lorem ipsum..",
|
|
"enabled": false,
|
|
"strategies": [
|
|
{
|
|
"name": "default",
|
|
"parameters": {}
|
|
}
|
|
],
|
|
"strategy": "default",
|
|
"parameters": {}
|
|
}
|
|
```
|