Skip to main content

Evaluate an Unleash context against a set of environments and projects.

POST 

/api/admin/playground

Deprecated. Will be removed in the next Unleash major update. Use the provided context, environment, and projects to evaluate toggles on this Unleash instance. Returns a list of all toggles that match the parameters and what they evaluate to. The response also contains the input parameters that were provided.

Request

Body

required

playgroundRequestSchema

    environment stringrequired

    The environment to evaluate toggles in.

    Example: development

    projects

    object

    A list of projects to check for toggles in.

    oneOf

    A list of projects to check for toggles in.

  • Array [

  • string

  • ]

  • context

    object

    required

    The Unleash context as modeled in client SDKs

    appName stringrequired

    The name of the application.

    Possible values: non-empty

    Example: My cool application.
    currentTime date-time

    A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.

    Example: 2022-07-05T12:56:41+02:00
    environment stringdeprecated

    The environment the app is running in.

    properties

    object

    Additional Unleash context properties

    property name* string
    remoteAddress string

    The app's IP address

    Example: 192.168.1.1
    sessionId string

    An identifier for the current session

    Example: b65e7b23-fec0-4814-a129-0e9861ef18fc
    userId string

    An identifier for the current user

    Example: username@provider.com
    property name* any

    The Unleash context as modeled in client SDKs

Responses

playgroundResponseSchema

Schema

    input

    object

    required

    The given input used to evaluate the features.

    environment stringrequired

    The environment to evaluate toggles in.

    Example: development

    projects

    object

    A list of projects to check for toggles in.

    oneOf

    A list of projects to check for toggles in.

  • Array [

  • string

  • ]

  • context

    object

    required

    The Unleash context as modeled in client SDKs

    appName stringrequired

    The name of the application.

    Possible values: non-empty

    Example: My cool application.
    currentTime date-time

    A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.

    Example: 2022-07-05T12:56:41+02:00
    environment stringdeprecated

    The environment the app is running in.

    properties

    object

    Additional Unleash context properties

    property name* string
    remoteAddress string

    The app's IP address

    Example: 192.168.1.1
    sessionId string

    An identifier for the current session

    Example: b65e7b23-fec0-4814-a129-0e9861ef18fc
    userId string

    An identifier for the current user

    Example: username@provider.com
    property name* any

    The Unleash context as modeled in client SDKs

    features

    object[]

    required

    The list of features that have been evaluated.

  • Array [

  • name stringrequired

    The feature's name.

    Example: my-feature
    projectId stringrequired

    The ID of the project that contains this feature.

    Example: my-project

    strategies

    object

    required

    The feature's applicable strategies and cumulative results of the strategies

    result

    object

    required

    The cumulative results of all the feature's strategies. Can be true, false, or unknown. This property will only be unknown if one or more of the strategies can't be fully evaluated and the rest of the strategies all resolve to false.

    anyOf

    boolean

    data

    object[]

    required

    The strategies that apply to this feature.

  • Array [

  • name stringrequired

    The strategy's name.

    title string

    Description of the feature's purpose.

    Example: Beta rollout
    id stringrequired

    The strategy's id.

    Example: 3AECCF7E-FF82-4174-8287-8EBE06079A50

    result

    object

    required

    The strategy's evaluation result. If the strategy is a custom strategy that Unleash can't evaluate, evaluationStatus will be unknown. Otherwise, it will be true or false

    anyOf

    evaluationStatus stringrequired

    Signals that this strategy could not be evaluated. This is most likely because you're using a custom strategy that Unleash doesn't know about. The unevaluated result is also returned if the strategy is disabled.

    Possible values: [incomplete, unevaluated]

    enabled

    object

    required

    Whether this strategy resolves to false or if it might resolve to true. Because Unleash can't evaluate the strategy, it can't say for certain whether it will be true, but if you have failing constraints or segments, it can determine that your strategy would be false.

    anyOf

    boolean

    Possible values: [false]

    disabled booleannullablerequired

    The strategy's status. Disabled strategies are not evaluated

    Example: false

    segments

    object[]

    required

    The strategy's segments and their evaluation results.

  • Array [

  • id integerrequired

    The segment's id.

    name stringrequired

    The name of the segment.

    Example: segment A
    result booleanrequired

    Whether this was evaluated as true or false.

    constraints

    object[]

    required

    The list of constraints in this segment.

  • Array [

  • contextName stringrequired

    The name of the context field that this constraint should apply to.

    Example: appName
    operator stringrequired

    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
    caseInsensitive boolean

    Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

    Default value: false
    inverted boolean

    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
    values string[]

    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"]
    value string

    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
    result booleanrequired

    Whether this was evaluated as true or false.

  • ]

  • ]

  • constraints

    object[]

    required

    The strategy's constraints and their evaluation results.

  • Array [

  • contextName stringrequired

    The name of the context field that this constraint should apply to.

    Example: appName
    operator stringrequired

    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
    caseInsensitive boolean

    Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

    Default value: false
    inverted boolean

    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
    values string[]

    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"]
    value string

    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
    result booleanrequired

    Whether this was evaluated as true or false.

  • ]

  • parameters

    object

    required

    The strategy's constraints and their evaluation results.

    property name* string

    links

    object

    required

    A set of links to actions you can perform on this strategy

    edit stringrequired
    Example: /projects/some-project/features/some-feature/strategies/edit?environmentId=some-env&strategyId= 3AECCF7E-FF82-4174-8287-8EBE06079A50
  • ]

  • hasUnsatisfiedDependency boolean

    Whether the feature has a parent dependency that is not satisfied

    isEnabledInCurrentEnvironment booleanrequired

    Whether the feature is active and would be evaluated in the provided environment in a normal SDK context.

    isEnabled booleanrequired

    Whether this feature is enabled or not in the current environment. If a feature can't be fully evaluated (that is, strategies.result is unknown), this will be false to align with how client SDKs treat unresolved feature states.

    Example: true

    variant

    object

    nullable

    required

    The feature variant you receive based on the provided context or the disabled variant. If a feature is disabled or doesn't have any variants, you would get the disabled variant. Otherwise, you'll get one of thefeature's defined variants.

    name stringrequired

    The variant's name. If there is no variant or if the flag is disabled, this will be disabled

    Example: red-variant
    enabled booleanrequired

    Whether the variant is enabled or not. If the feature is disabled or if it doesn't have variants, this property will be false

    payload

    object

    An optional payload attached to the variant.

    type stringrequired

    The format of the payload.

    value stringrequired

    The payload value stringified.

    Example: {"property": "value"}
    feature_enabled boolean

    Use featureEnabled instead.

    Example: true
    featureEnabled booleandeprecated

    Whether the feature is enabled or not.

    Example: true

    variants

    object[]

    required

    The feature variants.

  • Array [

  • name stringrequired

    The variants name. Is unique for this feature flag

    Example: blue_group
    weight numberrequired

    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

    weightType string

    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
    stickiness string

    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

    type stringrequired

    The type of the value. Commonly used types are string, number, json and csv.

    Possible values: [json, csv, string, number]

    value stringrequired

    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 [

  • contextName stringrequired

    The name of the context field used to determine overrides

    Example: userId
    values string[]required

    Which values that should be overriden

    Example: ["red","blue"]
  • ]

  • ]

  • ]

Loading...