Batch evaluate an Unleash context against a set of environments and projects.

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

{
  "input": {
    "environments": [
      "development",
      "production"
    ],
    "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"
    },
    "projects": [
      "my-project"
    ]
  },
  "features": [
    {
      "name": "my-feature",
      "projectId": "my-project",
      "environments": {}
    }
  ],
  "warnings": {
    "invalidContextProperties": [
      "string"
    ]
  }
}

Use the provided context, environments, and projects to evaluate toggles on this Unleash instance. You can use comma-separated values to provide multiple values to each context field. Returns a combinatorial list of all toggles that match the parameters and what they evaluate to. The response also contains the input parameters that were provided.

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

{
  "input": {
    "environments": [
      "development",
      "production"
    ],
    "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"
    },
    "projects": [
      "my-project"
    ]
  },
  "features": [
    {
      "name": "my-feature",
      "projectId": "my-project",
      "environments": {}
    }
  ],
  "warnings": {
    "invalidContextProperties": [
      "string"
    ]
  }
}

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Request

advancedPlaygroundRequestSchema

environmentslist of stringsRequired

The environments to evaluate toggles in.

contextobjectRequired

The Unleash context as modeled in client SDKs

projectslist of strings or enumOptional

A list of projects to check for toggles in.

Response

advancedPlaygroundResponseSchema

inputobject

The given input used to evaluate the features.

featureslist of objects

The list of features that have been evaluated.

warningsobject

Warnings that occurred during evaluation.

Errors

400

Bad Request Error

401

Unauthorized Error

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

1	{
2	"input": {
3	"environments": [
4	"development",
5	"production"
6	],
7	"context": {
8	"appName": "My cool application.",
9	"currentTime": "2022-07-05T12:56:41+02:00",
10	"properties": {
11	"customContextField": "this is one!",
12	"otherCustomField": "3"
13	},
14	"remoteAddress": "192.168.1.1",
15	"sessionId": "b65e7b23-fec0-4814-a129-0e9861ef18fc",
16	"userId": "username@provider.com",
17	"environment": "string"
18	},
19	"projects": [
20	"my-project"
21	]
22	},
23	"features": [
24	{
25	"name": "my-feature",
26	"projectId": "my-project",
27	"environments": {}
28	}
29	],
30	"warnings": {
31	"invalidContextProperties": [
32	"string"
33	]
34	}
35	}