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

236 lines
4.6 KiB
Markdown
Raw Normal View History

---
id: features
title: /api/admin/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/admin/features`
2016-09-06 21:23:56 +02:00
2018-11-22 11:20:28 +01:00
This endpoint is the one all admin ui 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
**Example response:**
2018-11-22 11:20:28 +01:00
2016-09-06 21:23:56 +02:00
```json
{
2017-06-28 10:17:48 +02:00
"version": 2,
2016-09-06 21:23:56 +02:00
"features": [
{
"name": "Feature.A",
"description": "lorem ipsum",
"enabled": false,
"strategies": [
{
"name": "default",
"parameters": {}
}
2018-01-30 15:57:12 +01:00
],
"variants": [
{
"name": "variant1",
2019-01-24 11:26:07 +01:00
"weight": 50
2018-01-30 15:57:12 +01:00
},
{
"name": "variant2",
2019-01-24 11:26:07 +01:00
"weight": 50
2018-01-30 15:57:12 +01:00
}
2017-06-28 10:17:48 +02:00
]
2016-09-06 21:23:56 +02:00
},
{
"name": "Feature.B",
"description": "lorem ipsum",
"enabled": true,
"strategies": [
{
"name": "ActiveForUserWithId",
"parameters": {
"userIdList": "123,221,998"
}
},
{
"name": "GradualRolloutRandom",
"parameters": {
"percentage": "10"
}
}
2018-01-30 15:57:12 +01:00
],
"variants": []
2016-09-06 21:23:56 +02:00
}
]
}
```
2017-06-28 10:17:48 +02:00
`GET: http://unleash.host.com/api/admin/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 featureToggle. This is mostly provded 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
```json
{
"name": "Feature.A",
"description": "lorem ipsum..",
"enabled": false,
"strategies": [
{
"name": "default",
"parameters": {}
}
2018-01-30 15:57:12 +01:00
],
"variants": []
2016-09-06 21:23:56 +02:00
}
```
### Create a new Feature Toggle
2017-06-28 10:17:48 +02:00
`POST: http://unleash.host.com/api/admin/features/`
2016-09-06 21:23:56 +02:00
**Body:**
2018-11-22 11:20:28 +01:00
```json
2016-09-06 21:23:56 +02:00
{
"name": "Feature.A",
"description": "lorem ipsum..",
"enabled": false,
"strategies": [
{
"name": "default",
"parameters": {}
}
]
}
```
2018-11-22 11:20:28 +01:00
Used by the admin-dashboard to create a new feature toggles. The name **must be unique**, otherwise you will get a _403-response_.
2016-09-06 21:23:56 +02:00
2018-11-22 11:20:28 +01:00
Returns 200-respose if the feature toggle was created successfully.
2016-09-06 21:23:56 +02:00
2016-09-07 12:12:17 +02:00
### Update a Feature Toggle
2016-09-06 21:23:56 +02:00
2017-06-28 10:17:48 +02:00
`PUT: http://unleash.host.com/api/admin/features/:toggleName`
2016-09-06 21:23:56 +02:00
**Body:**
2018-11-22 11:20:28 +01:00
```json
2016-09-06 21:23:56 +02:00
{
"name": "Feature.A",
"description": "lorem ipsum..",
"enabled": false,
"strategies": [
{
"name": "default",
"parameters": {}
}
2018-01-30 15:57:12 +01:00
],
"variants": []
2016-09-06 21:23:56 +02:00
}
```
2018-11-22 11:20:28 +01:00
Used by the admin dashboard to update a feature toggles. The name has to match an existing features toggle.
2016-09-06 21:23:56 +02:00
2018-11-22 11:20:28 +01:00
Returns 200-respose if the feature toggle was updated successfully.
2016-09-06 21:23:56 +02:00
2016-09-07 12:12:17 +02:00
### Archive a Feature Toggle
2017-06-28 10:17:48 +02:00
`DELETE: http://unleash.host.com/api/admin/features/:toggleName`
2016-09-07 12:12:17 +02:00
2018-11-22 11:20:28 +01:00
Used to archive a feature toggle. A feature toggle can never be totally be deleted, but can be archived. This is a design decision to make sure that a old feature toggle suddenly reappears becuase someone else re-using the same name.
2016-09-07 12:12:17 +02:00
### Enable a Feature Toggle
`POST: http://unleash.host.com/api/admin/features/:featureName/toggle/on`
Used to enable a feature toggle. The :featureName must match an existing Feature Toggle. Returns 200-response if the feature toggle was enabled successfully.
**Body**
None
**Example response:**
```json
{
"name": "Feature.A",
"description": "lorem ipsum..",
"enabled": true,
"strategies": [
{
"name": "default",
"parameters": {}
}
],
"variants": []
}
```
### Disable a Feature Toggle
`POST: http://unleash.host.com/api/admin/features/:featureName/toggle/off`
Used to disable a feature toggle. The :featureName must match an existing Feature Toggle. Returns 200-response if the feature toggle was disabled successfully.
**Body**
None
**Example response:**
```json
{
"name": "Feature.A",
"description": "lorem ipsum..",
"enabled": false,
"strategies": [
{
"name": "default",
"parameters": {}
}
],
"variants": []
}
```
2016-09-07 12:12:17 +02:00
## Archive
### Fetch archived toggles
2017-06-28 10:17:48 +02:00
`GET http://unleash.host.com/api/admin/archive/features`
2016-09-07 12:12:17 +02:00
Used to fetch list of archived feature toggles
**Example response:**
2018-11-22 11:20:28 +01:00
2016-09-07 12:12:17 +02:00
```json
{
"version": 1,
"features": [
{
"name": "Feature.A",
"description": "lorem ipsum",
"enabled": false,
"strategies": [
{
"name": "default",
"parameters": {}
}
],
2018-01-30 15:57:12 +01:00
"variants": [],
2016-09-07 12:12:17 +02:00
"strategy": "default",
"parameters": {}
}
]
}
```
### Revive feature toggle
2017-06-28 10:17:48 +02:00
`POST http://unleash.host.com/api/admin/archive/revive`
2016-09-07 12:12:17 +02:00
**Body:**
2018-11-22 11:20:28 +01:00
```json
2016-09-07 12:12:17 +02:00
{
"name": "Feature.A"
}
```
2018-11-22 11:20:28 +01:00
Used to revive a feature toggle.