Get context instances — LaunchDarkly

Get context instances by ID.

Path parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

idstringRequired

The context instance ID

Query parameters

limitlongOptional

Specifies the maximum number of context instances to return (max: 50, default: 20)

continuationTokenstringOptional

Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the next link we provide instead.

sortstringOptional

Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying ts for this value, or descending order by specifying -ts.

filterstringOptional

A comma-separated list of context filters. This endpoint only accepts an applicationId filter. To learn more about the filter syntax, read Filtering contexts and context instances.

includeTotalCountbooleanOptional

Specifies whether to include or omit the total count of matching context instances. Defaults to true.

Response

Context instances collection response

_environmentIdstring

The environment ID

itemslist of objects

A collection of context instances. Can include multiple versions of context instances that have the same id, but different applicationIds.

_linksmap from strings to objectsOptional

The location and content type of related resources

totalCountintegerOptional

The number of unique context instances

continuationTokenstringOptional

An obfuscated string that references the last context instance on the previous page of results. You can use this for pagination, however, we recommend using the next link instead.

Errors

1 curl https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/context-instances/id \ 2 -H "Authorization: <apiKey>"

1 { 2 "_environmentId": "57be1db38b75bf0772d11384", 3 "items": [ 4 { 5 "id": "b3JnOmxhdW5jaGRhcmtseQ", 6 "context": { 7 "key": "value" 8 }, 9 "lastSeen": "2022-04-15T15:00:57Z", 10 "applicationId": "GoSDK/1.2", 11 "anonymousKinds": [ 12 "device", 13 "privateKind" 14 ], 15 "_links": { 16 "parent": { 17 "href": "/api/v2/projects/my-project/environments/my-environment", 18 "type": "application/json" 19 }, 20 "self": { 21 "href": "/api/v2/projects/my-project/environments/my-env/context-instances/organization:launch-darkly:user:henry?filter=applicationId:\"GoSDK/1.2\"", 22 "type": "application/json" 23 }, 24 "site": { 25 "href": "/my-project/my-environment/context-instances/organization:launch-darkly:user:henry", 26 "type": "text/html" 27 } 28 }, 29 "_access": { 30 "denied": [ 31 { 32 "action": "action", 33 "reason": { 34 "effect": "allow" 35 } 36 } 37 ], 38 "allowed": [ 39 { 40 "action": "action", 41 "reason": { 42 "effect": "allow" 43 } 44 } 45 ] 46 } 47 } 48 ], 49 "_links": { 50 "next": { 51 "href": "/api/v2/projects/my-project/environments/my-env/context-instances/organization:launch-darkly:user:henry?limit=2&continuationToken=2022-04-15T15:00:57.526470334Z", 52 "type": "application/json" 53 }, 54 "self": { 55 "href": "/api/v2/projects/my-proj/environments/my-env/context-instances/organization:launch-darkly:user:henry-jacobs?limit=2", 56 "type": "application/json" 57 } 58 }, 59 "totalCount": 100, 60 "continuationToken": "QAGFKH1313KUGI2351" 61 }

1	curl https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/context-instances/id \
2	-H "Authorization: <apiKey>"

1	{
2	"_environmentId": "57be1db38b75bf0772d11384",
3	"items": [
4	{
5	"id": "b3JnOmxhdW5jaGRhcmtseQ",
6	"context": {
7	"key": "value"
8	},
9	"lastSeen": "2022-04-15T15:00:57Z",
10	"applicationId": "GoSDK/1.2",
11	"anonymousKinds": [
12	"device",
13	"privateKind"
14	],
15	"_links": {
16	"parent": {
17	"href": "/api/v2/projects/my-project/environments/my-environment",
18	"type": "application/json"
19	},
20	"self": {
21	"href": "/api/v2/projects/my-project/environments/my-env/context-instances/organization:launch-darkly:user:henry?filter=applicationId:\"GoSDK/1.2\"",
22	"type": "application/json"
23	},
24	"site": {
25	"href": "/my-project/my-environment/context-instances/organization:launch-darkly:user:henry",
26	"type": "text/html"
27	}
28	},
29	"_access": {
30	"denied": [
31	{
32	"action": "action",
33	"reason": {
34	"effect": "allow"
35	}
36	}
37	],
38	"allowed": [
39	{
40	"action": "action",
41	"reason": {
42	"effect": "allow"
43	}
44	}
45	]
46	}
47	}
48	],
49	"_links": {
50	"next": {
51	"href": "/api/v2/projects/my-project/environments/my-env/context-instances/organization:launch-darkly:user:henry?limit=2&continuationToken=2022-04-15T15:00:57.526470334Z",
52	"type": "application/json"
53	},
54	"self": {
55	"href": "/api/v2/projects/my-proj/environments/my-env/context-instances/organization:launch-darkly:user:henry-jacobs?limit=2",
56	"type": "application/json"
57	}
58	},
59	"totalCount": 100,
60	"continuationToken": "QAGFKH1313KUGI2351"
61	}