mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
---
|
|
id: proxy-api
|
|
title: The Unleash Proxy api
|
|
---
|
|
|
|
For a high level introduction to the Unleash-proxy, please read this short article [The Unleash-Proxy](https://www.unleash-hosted.com/articles/the-unleash-proxy)
|
|
|
|
The Unleash-proxy consist of the proxy that exposes a simple API for the client.
|
|
|
|
|
|
|
|
## The Proxy-client {#the-proxy-client}
|
|
|
|
There is a js implementation of the proxy-client available. Find it here: [https://github.com/unleash/unleash-proxy-client-js](https://github.com/unleash/unleash-proxy-client-js)
|
|
|
|
## The Proxy-API {#the-proxy-api}
|
|
|
|
When accessing the Proxy, [Unleash context fields](unleash_context) from the session context can be added as parameters to the request. The proxy will return only enabled feature toggles and their evaluated value for the given context. You may also use custom context fields in combination with [strategy constraints](/advanced/strategy_constraints).
|
|
|
|
```sh
|
|
https://hostname.com/api/proxy?appName=webapp&userId=123&country=NO
|
|
```
|
|
|
|
The Proxy will return a list of all the active feature toggles, including variants, available. See an example below
|
|
|
|
```json
|
|
{
|
|
"toggles": [
|
|
{
|
|
"enabled": true,
|
|
"name": "SimpleToggle",
|
|
"variant": {
|
|
"enabled": false,
|
|
"name": "disabled"
|
|
}
|
|
},
|
|
{
|
|
"enabled": true,
|
|
"name": "ToggleWithVariant",
|
|
"variant": {
|
|
"enabled": true,
|
|
"name": "brown"
|
|
}
|
|
},
|
|
{
|
|
"enabled": true,
|
|
"name": "ToggleWithVariantAndPayload",
|
|
"variant": {
|
|
"enabled": true,
|
|
"name": "default",
|
|
"payload": {
|
|
"type": "string",
|
|
"value": "Some custom value here!"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|