1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
unleash.unleash/docs/api/client/feature-toggles-api.md

96 lines
2.5 KiB
Markdown
Raw Normal View History

---
id: features
title: /api/client/features
---
2016-09-06 21:23:56 +02:00
### Fetching Feature Toggles
2017-06-28 10:17:48 +02:00
`GET: http://unleash.host.com/api/client/features`
2016-09-06 21:23:56 +02:00
2016-11-09 12:41:11 +01:00
**HEADERS:**
2018-11-22 11:20:28 +01:00
- UNLEASH-APPNAME: appName
- UNLEASH-INSTANCEID: instanceId
2016-11-09 12:41:11 +01:00
2018-11-22 11:20:28 +01:00
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.
2016-09-06 21:23:56 +02:00
2018-11-22 11:20:28 +01:00
> _Note:_ Clients should prefer the `strategies` property. Legacy properties (`strategy` & `parameters`) will be kept until **version 2** of the format.
2016-09-06 21:23:56 +02:00
2018-11-22 11:20:28 +01:00
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.
2016-09-06 21:23:56 +02:00
**Example response:**
2018-11-22 11:20:28 +01:00
2016-09-06 21:23:56 +02:00
```json
{
"version": 1,
"features": [
{
"name": "Feature.A",
"description": "lorem ipsum",
"type": "release",
2016-09-06 21:23:56 +02:00
"enabled": false,
"stale": false,
2016-09-06 21:23:56 +02:00
"strategies": [
{
"name": "default",
"parameters": {}
}
],
"strategy": "default",
"parameters": {}
},
{
"name": "Feature.B",
"type": "killswitch",
2016-09-06 21:23:56 +02:00
"description": "lorem ipsum",
"enabled": true,
"stale": false,
2016-09-06 21:23:56 +02:00
"strategies": [
{
"name": "ActiveForUserWithId",
"parameters": {
"userIdList": "123,221,998"
}
},
{
"name": "GradualRolloutRandom",
"parameters": {
"percentage": "10"
}
}
],
"strategy": "ActiveForUserWithId",
"parameters": {
"userIdList": "123,221,998"
}
}
]
}
```
2018-11-22 11:20:28 +01:00
You may limit the response by sending a `namePrefix` query-parameter.
2017-06-28 10:17:48 +02:00
`GET: http://unleash.host.com/api/client/features/:featureName`
2016-09-06 21:23:56 +02:00
2018-11-22 11:20:28 +01:00
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.
2016-09-06 21:23:56 +02:00
2018-11-22 11:20:28 +01:00
> _Notice_: You will not get a version property when fetching a specific feature toggle by name.
2016-09-06 21:23:56 +02:00
```json
{
"name": "Feature.A",
"description": "lorem ipsum..",
"type": "release",
2016-09-06 21:23:56 +02:00
"enabled": false,
"stale": false,
2016-09-06 21:23:56 +02:00
"strategies": [
{
"name": "default",
"parameters": {}
}
],
"strategy": "default",
"parameters": {}
}
```