Playground

Evaluate an Unleash context against a change request preview.

Changed on

Enterprise feature

Use the provided context to evaluate toggles on this Unleash instance with a change request applied in preview mode. 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.

post/api/admin/playground/change-request/{id}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/playground/change-request/{id}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

idstring required

Request body

Example request

{
  "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"
  }
}

Response

advancedPlaygroundResponseSchema

Example response

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

Changes

  • b2c3116e633eRevision changes
    • warning

      added the new SEMVER_GTE enum value to the ////////// response property for the response status

    • warning

      added the new SEMVER_GTE enum value to the //////////// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the ////////// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the //////////// response property for the response status

  • 774670258f04Revision changes
    • warning

      added the new REGEX enum value to the ////////// response property for the response status

    • warning

      added the new REGEX enum value to the //////////// response property for the response status