Features

[BETA] Get partial updates (SDK)

Changed on

Enterprise feature

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

Initially returns the full set of feature flags available to the provided API key. When called again with the returned etag, only returns the flags that have changed

get/api/client/delta

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/client/delta
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Response

clientFeaturesDeltaSchema

Example response

{
  "events": [
    {
      "feature": {
        "name": "new.payment.flow.stripe",
        "type": "release",
        "description": "No variants here",
        "enabled": true,
        "project": "new.payment.flow",
        "strategies": [
          {
            "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
            "name": "flexibleRollout",
            "title": "Gradual Rollout 25-Prod",
            "featureName": "myAwesomeFeature",
            "sortOrder": 9999,
            "segments": [
              1,
              2
            ],
            "constraints": [
              {
                "contextName": "appName",
                "operator": "IN",
                "values": [
                  "my-app",
                  "my-other-app"
                ],
                "value": "my-app"
              }
            ],
            "variants": [
              {
                "name": "blue_group",
                "weightType": "fix",
                "stickiness": "custom.context.field",
                "payload": {
                  "type": "json",
                  "value": "{\"color\": \"red\"}"
                }
              }
            ]
          }
        ],
        "variants": [
          {
            "name": "blue_group",
            "weightType": "variable",
            "stickiness": "custom.context.field",
            "payload": {
              "type": "json",
              "value": "{\"color\": \"red\"}"
            },
            "overrides": [
              {
                "contextName": "userId",
                "values": [
                  "red",
                  "blue"
                ]
              }
            ]
          }
        ],
        "dependencies": [
          {
            "feature": "parent_feature",
            "variants": [
              "variantA",
              "variantB"
            ]
          }
        ]
      }
    }
  ]
}

Changes

    • info

      added subschema #1 subschema #3 subschema #5 to the / response property anyOf list for the response status

    • info

      removed subschema #1 subschema #3 subschema #5 from the / response property anyOf list for the response status

    • info

      api tag Features added

    • info

      api tag Unstable removed

    • info

      added subschema #1 subschema #3 subschema #5 to the / response property anyOf list for the response status

    • info

      removed subschema #1 subschema #3 subschema #5 from the / response property anyOf list for the response status