[BETA] Evaluate a single feature flag against an Unleash context in an environment.

POST

https://app.unleash-instance.example.com/api/admin/playground/features/:featureName

POST

/api/admin/playground/features/:featureName

curl -X POST https://app.unleash-instance.example.com/api/admin/playground/features/featureName \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "environment": "development",
  "context": {
    "appName": "My cool application."
  }
}'

{
  "input": {
    "environment": "development",
    "context": {
      "appName": "My cool application.",
      "currentTime": "2022-07-05T12:56:41+02:00",
      "properties": {
        "customContextField": "this is one!",
        "otherCustomField": "3"
      },
      "remoteAddress": "192.168.1.1",
      "sessionId": "b65e7b23-fec0-4814-a129-0e9861ef18fc",
      "userId": "username@provider.com",
      "environment": "string"
    }
  },
  "feature": {
    "name": "my-feature",
    "projectId": "my-project",
    "strategies": {
      "result": "unknown",
      "data": [
        {
          "name": "string",
          "id": "3AECCF7E-FF82-4174-8287-8EBE06079A50",
          "result": {
            "enabled": false,
            "evaluationStatus": "incomplete"
          },
          "disabled": false,
          "segments": [
            {
              "id": 1,
              "name": "segment A",
              "result": true,
              "constraints": [
                {
                  "contextName": "appName",
                  "operator": "IN",
                  "result": true,
                  "caseInsensitive": false,
                  "inverted": false,
                  "values": [
                    "my-app",
                    "my-other-app"
                  ],
                  "value": "my-app"
                }
              ]
            }
          ],
          "constraints": [
            {
              "contextName": "appName",
              "operator": "IN",
              "result": true,
              "caseInsensitive": false,
              "inverted": false,
              "values": [
                "my-app",
                "my-other-app"
              ],
              "value": "my-app"
            }
          ],
          "parameters": {
            "myParam1": "param value"
          },
          "links": {
            "edit": "/projects/some-project/features/some-feature/strategies/edit?environmentId=some-env&strategyId= 3AECCF7E-FF82-4174-8287-8EBE06079A50"
          },
          "title": "Beta rollout"
        }
      ]
    },
    "isEnabledInCurrentEnvironment": true,
    "isEnabled": true,
    "variant": {
      "name": "green",
      "enabled": true
    },
    "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"
            ]
          }
        ]
      }
    ],
    "hasUnsatisfiedDependency": true
  }
}

[BETA] This API is in beta state, which means it may change or be removed in the future.

Use the provided context and environment to evaluate a single feature flag on this Unleash instance. The project is resolved from the flag name. Returns what the flag evaluates to, together with the input parameters that were provided.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

featureNamestringRequired

Request

playgroundFeatureRequestSchema

environmentstringRequired

The environment to evaluate the feature flag in.

contextobjectRequired

The Unleash context as modeled in client SDKs

Response

playgroundFeatureResponseSchema

inputobject

The given input used to evaluate the feature.

featureobject

The evaluated feature.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error