Get a single feature flag

GET 
<your-unleash-url>/api/client/features/:featureName

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

Request

Path Parameters

featureName stringrequired

Responses

200

clientFeatureSchema

application/json

Schema

Schema

namestringrequired
The unique name of a feature flag. Is validated to be URL safe on creation
Example: new.payment.flow.stripe
typestring
What kind of feature flag is this. Refer to the documentation on feature flag types for more information
Example: release
descriptionstringnullable
A description of the flag
Example: No variants here
enabledbooleanrequired
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
Example: true
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
Example: false
impressionDatabooleannullable
Set to true if SDKs should trigger impression events when this flag is evaluated
Example: false
projectstring
Which project this feature flag belongs to
Example: new.payment.flow
strategies object[]
Evaluation strategies for this flag. Each entry in this list will be evaluated and ORed together
Array [
idstring
A uuid for the feature strategy
Example: 6b5157cb-343a-41e7-bfa3-7b4ec3044840
namestringrequired
The name or type of strategy
Example: flexibleRollout
titlestringnullable
A descriptive title for the strategy
Example: Gradual Rollout 25-Prod
disabledbooleannullable
A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs
Example: false
featureNamestring
The name or feature the strategy is attached to
Example: myAwesomeFeature
sortOrdernumber
The order of the strategy in the list
Example: 9999
segmentsnumber[]
A list of segment ids attached to the strategy
Example: [1,2]
constraints object[]
A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints
Array [
contextNamestringrequired
The name of the context field that this constraint should apply to.
Example: appName
operatorstringrequired
The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.
Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]
Example: IN
caseInsensitiveboolean
Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).
Default value: false
invertedboolean
Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.
Default value: false
valuesstring[]
The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.
Example: ["my-app","my-other-app"]
valuestring
The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.
Example: my-app
]
variants object[]
Strategy level variants
Array [
namestringrequired
The variant name. Must be unique for this feature flag
Example: blue_group
weightintegerrequired
The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on variant weights for more information
Possible values: <= 1000
weightTypestringrequired
Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the variant weight documentation.
Possible values: [variable, fix]
Example: fix
stickinessstringrequired
The stickiness to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time
Example: custom.context.field
payload object
Extra data configured for this variant
typestringrequired
The type of the value. Commonly used types are string, number, json and csv.
Possible values: [json, csv, string, number]
valuestringrequired
The actual value of payload
]
parameters object
A list of parameters for a strategy
property name*string
]
variants object[]nullable
Variants configured for this flag
Array [
namestringrequired
The variants name. Is unique for this feature flag
Example: blue_group
weightnumberrequired
The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on variant weights for more information
Possible values: <= 1000
weightTypestring
Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000
Possible values: [variable, fix]
Example: variable
stickinessstring
Stickiness is how Unleash guarantees that the same user gets the same variant every time
Example: custom.context.field
payload object
Extra data configured for this variant
typestringrequired
The type of the value. Commonly used types are string, number, json and csv.
Possible values: [json, csv, string, number]
valuestringrequired
The actual value of payload
overrides object[]
Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.
Array [
contextNamestringrequired
The name of the context field used to determine overrides
Example: userId
valuesstring[]required
Which values that should be overriden
Example: ["red","blue"]
]
]
dependencies object[]
Feature dependencies for this flag
Array [
featurestringrequired
The name of the feature we depend on.
Example: parent_feature
enabledboolean
Whether the parent feature should be enabled. When false variants are ignored. true by default.
Example: false
variantsstring[]
The list of variants the parent feature should resolve to. Leave empty when you only want to check the enabled status.
Example: ["variantA","variantB"]
]

Example (auto)

{
  "name": "new.payment.flow.stripe",
  "type": "release",
  "description": "No variants here",
  "enabled": true,
  "stale": false,
  "impressionData": false,
  "project": "new.payment.flow",
  "strategies": [
    {
      "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
      "name": "flexibleRollout",
      "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": 0,
          "weightType": "fix",
          "stickiness": "custom.context.field",
          "payload": {
            "type": "json",
            "value": "{\"color\": \"red\"}"
          }
        }
      ],
      "parameters": {}
    }
  ],
  "variants": [
    {
      "name": "blue_group",
      "weight": 0,
      "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"
      ]
    }
  ]
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/client/features/:featureName' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

featureName — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!