Get a single feature flag | Unleash Documentation

curl https://app.unleash-instance.example.com/api/client/features/featureName \
     -H "Authorization: <apiKey>"

{
  "name": "new.payment.flow.stripe",
  "enabled": true,
  "type": "release",
  "description": "No variants here",
  "stale": false,
  "impressionData": false,
  "project": "new.payment.flow",
  "strategies": [
    {
      "name": "flexibleRollout",
      "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
      "title": "Gradual Rollout 25-Prod",
      "disabled": false,
      "featureName": "myAwesomeFeature",
      "sortOrder": 9999,
      "segments": [
        1,
        2
      ],
      "constraints": [
        {
          "contextName": "appName",
          "operator": "IN",
          "caseInsensitive": false,
          "inverted": false,
          "values": [
            "my-app",
            "my-other-app"
          ],
          "value": "my-app"
        }
      ],
      "variants": [
        {
          "name": "blue_group",
          "weight": 1,
          "weightType": "fix",
          "stickiness": "custom.context.field",
          "payload": {
            "type": "json",
            "value": "{\"color\": \"red\"}"
          }
        }
      ],
      "parameters": {}
    }
  ],
  "variants": [
    {
      "name": "blue_group",
      "weight": 1.1,
      "weightType": "variable",
      "stickiness": "custom.context.field",
      "payload": {
        "type": "json",
        "value": "{\"color\": \"red\"}"
      },
      "overrides": [
        {
          "contextName": "userId",
          "values": [
            "red",
            "blue"
          ]
        }
      ]
    }
  ],
  "dependencies": [
    {
      "feature": "parent_feature",
      "enabled": false,
      "variants": [
        "variantA",
        "variantB"
      ]
    }
  ]
}

Gets all the client data for a single flag. Contains the exact same information about a flag as the /api/client/features endpoint does, but only contains data about the specified flag. All SDKs should use /api/client/features

curl https://app.unleash-instance.example.com/api/client/features/featureName \
     -H "Authorization: <apiKey>"

{
  "name": "new.payment.flow.stripe",
  "enabled": true,
  "type": "release",
  "description": "No variants here",
  "stale": false,
  "impressionData": false,
  "project": "new.payment.flow",
  "strategies": [
    {
      "name": "flexibleRollout",
      "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
      "title": "Gradual Rollout 25-Prod",
      "disabled": false,
      "featureName": "myAwesomeFeature",
      "sortOrder": 9999,
      "segments": [
        1,
        2
      ],
      "constraints": [
        {
          "contextName": "appName",
          "operator": "IN",
          "caseInsensitive": false,
          "inverted": false,
          "values": [
            "my-app",
            "my-other-app"
          ],
          "value": "my-app"
        }
      ],
      "variants": [
        {
          "name": "blue_group",
          "weight": 1,
          "weightType": "fix",
          "stickiness": "custom.context.field",
          "payload": {
            "type": "json",
            "value": "{\"color\": \"red\"}"
          }
        }
      ],
      "parameters": {}
    }
  ],
  "variants": [
    {
      "name": "blue_group",
      "weight": 1.1,
      "weightType": "variable",
      "stickiness": "custom.context.field",
      "payload": {
        "type": "json",
        "value": "{\"color\": \"red\"}"
      },
      "overrides": [
        {
          "contextName": "userId",
          "values": [
            "red",
            "blue"
          ]
        }
      ]
    }
  ],
  "dependencies": [
    {
      "feature": "parent_feature",
      "enabled": false,
      "variants": [
        "variantA",
        "variantB"
      ]
    }
  ]
}

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

featureNamestringRequired

Response

clientFeatureSchema

namestring

The unique name of a feature flag. Is validated to be URL safe on creation

enabledboolean

Whether the feature flag is enabled for the current API key or not. This is ANDed with the evaluation results of the strategies list, so if this is false, the evaluation result will always be false

typestring

What kind of feature flag is this. Refer to the documentation on feature flag types for more information

descriptionstring or null

A description of the flag

staleboolean

If this is true Unleash believes this feature flag has been active longer than Unleash expects a flag of this type to be active

impressionDataboolean or null

Set to true if SDKs should trigger impression events when this flag is evaluated

projectstring

Which project this feature flag belongs to

strategieslist of objects

Evaluation strategies for this flag. Each entry in this list will be evaluated and ORed together

variantslist of objects or null

Variants configured for this flag

dependencieslist of objects

Feature dependencies for this flag

$	curl https://app.unleash-instance.example.com/api/client/features/featureName \
>	-H "Authorization: <apiKey>"

1	{
2	"name": "new.payment.flow.stripe",
3	"enabled": true,
4	"type": "release",
5	"description": "No variants here",
6	"stale": false,
7	"impressionData": false,
8	"project": "new.payment.flow",
9	"strategies": [
10	{
11	"name": "flexibleRollout",
12	"id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
13	"title": "Gradual Rollout 25-Prod",
14	"disabled": false,
15	"featureName": "myAwesomeFeature",
16	"sortOrder": 9999,
17	"segments": [
18	1,
19	2
20	],
21	"constraints": [
22	{
23	"contextName": "appName",
24	"operator": "IN",
25	"caseInsensitive": false,
26	"inverted": false,
27	"values": [
28	"my-app",
29	"my-other-app"
30	],
31	"value": "my-app"
32	}
33	],
34	"variants": [
35	{
36	"name": "blue_group",
37	"weight": 1,
38	"weightType": "fix",
39	"stickiness": "custom.context.field",
40	"payload": {
41	"type": "json",
42	"value": "{\"color\": \"red\"}"
43	}
44	}
45	],
46	"parameters": {}
47	}
48	],
49	"variants": [
50	{
51	"name": "blue_group",
52	"weight": 1.1,
53	"weightType": "variable",
54	"stickiness": "custom.context.field",
55	"payload": {
56	"type": "json",
57	"value": "{\"color\": \"red\"}"
58	},
59	"overrides": [
60	{
61	"contextName": "userId",
62	"values": [
63	"red",
64	"blue"
65	]
66	}
67	]
68	}
69	],
70	"dependencies": [
71	{
72	"feature": "parent_feature",
73	"enabled": false,
74	"variants": [
75	"variantA",
76	"variantB"
77	]
78	}
79	]
80	}