[BETA] Get partial updates (SDK) | Unleash Documentation

curl https://app.unleash-instance.example.com/api/client/delta \
     -H "Authorization: <apiKey>"

{
  "events": [
    {
      "eventId": 1.1,
      "type": "feature-updated",
      "feature": {
        "name": "new.payment.flow.stripe",
        "type": "release",
        "description": "No variants here",
        "enabled": true,
        "stale": false,
        "impressionData": false,
        "project": "new.payment.flow",
        "strategies": [
          {
            "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
            "name": "flexibleRollout",
            "title": "Gradual Rollout 25-Prod",
            "disabled": false,
            "featureName": "myAwesomeFeature",
            "sortOrder": 9999,
            "segments": [
              1,
              2
            ],
            "constraints": [
              {
                "contextName": "appName",
                "operator": "IN",
                "caseInsensitive": false,
                "inverted": false,
                "values": [
                  "my-app",
                  "my-other-app"
                ],
                "value": "my-app"
              }
            ],
            "variants": [
              {
                "name": "blue_group",
                "weight": 1,
                "weightType": "fix",
                "stickiness": "custom.context.field",
                "payload": {
                  "type": "json",
                  "value": "{\"color\": \"red\"}"
                }
              }
            ],
            "parameters": {}
          }
        ],
        "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"
                ]
              }
            ]
          }
        ],
        "dependencies": [
          {
            "feature": "parent_feature",
            "enabled": false,
            "variants": [
              "variantA",
              "variantB"
            ]
          }
        ]
      }
    }
  ]
}

curl https://app.unleash-instance.example.com/api/client/delta \
     -H "Authorization: <apiKey>"

{
  "events": [
    {
      "eventId": 1.1,
      "type": "feature-updated",
      "feature": {
        "name": "new.payment.flow.stripe",
        "type": "release",
        "description": "No variants here",
        "enabled": true,
        "stale": false,
        "impressionData": false,
        "project": "new.payment.flow",
        "strategies": [
          {
            "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
            "name": "flexibleRollout",
            "title": "Gradual Rollout 25-Prod",
            "disabled": false,
            "featureName": "myAwesomeFeature",
            "sortOrder": 9999,
            "segments": [
              1,
              2
            ],
            "constraints": [
              {
                "contextName": "appName",
                "operator": "IN",
                "caseInsensitive": false,
                "inverted": false,
                "values": [
                  "my-app",
                  "my-other-app"
                ],
                "value": "my-app"
              }
            ],
            "variants": [
              {
                "name": "blue_group",
                "weight": 1,
                "weightType": "fix",
                "stickiness": "custom.context.field",
                "payload": {
                  "type": "json",
                  "value": "{\"color\": \"red\"}"
                }
              }
            ],
            "parameters": {}
          }
        ],
        "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"
                ]
              }
            ]
          }
        ],
        "dependencies": [
          {
            "feature": "parent_feature",
            "enabled": false,
            "variants": [
              "variantA",
              "variantB"
            ]
          }
        ]
      }
    }
  ]
}

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

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Response

clientFeaturesDeltaSchema

eventslist of objects

A list of delta events.

$	curl https://app.unleash-instance.example.com/api/client/delta \
>	-H "Authorization: <apiKey>"

1	{
2	"events": [
3	{
4	"eventId": 1.1,
5	"type": "feature-updated",
6	"feature": {
7	"name": "new.payment.flow.stripe",
8	"type": "release",
9	"description": "No variants here",
10	"enabled": true,
11	"stale": false,
12	"impressionData": false,
13	"project": "new.payment.flow",
14	"strategies": [
15	{
16	"id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
17	"name": "flexibleRollout",
18	"title": "Gradual Rollout 25-Prod",
19	"disabled": false,
20	"featureName": "myAwesomeFeature",
21	"sortOrder": 9999,
22	"segments": [
23	1,
24	2
25	],
26	"constraints": [
27	{
28	"contextName": "appName",
29	"operator": "IN",
30	"caseInsensitive": false,
31	"inverted": false,
32	"values": [
33	"my-app",
34	"my-other-app"
35	],
36	"value": "my-app"
37	}
38	],
39	"variants": [
40	{
41	"name": "blue_group",
42	"weight": 1,
43	"weightType": "fix",
44	"stickiness": "custom.context.field",
45	"payload": {
46	"type": "json",
47	"value": "{\"color\": \"red\"}"
48	}
49	}
50	],
51	"parameters": {}
52	}
53	],
54	"variants": [
55	{
56	"name": "blue_group",
57	"weight": 1.1,
58	"weightType": "variable",
59	"stickiness": "custom.context.field",
60	"payload": {
61	"type": "json",
62	"value": "{\"color\": \"red\"}"
63	},
64	"overrides": [
65	{
66	"contextName": "userId",
67	"values": [
68	"red",
69	"blue"
70	]
71	}
72	]
73	}
74	],
75	"dependencies": [
76	{
77	"feature": "parent_feature",
78	"enabled": false,
79	"variants": [
80	"variantA",
81	"variantB"
82	]
83	}
84	]
85	}
86	}
87	]
88	}