Search for contexts

POST

/api/v2/projects/:projectKey/environments/:environmentKey/contexts/search

POST

/api/v2/projects/:projectKey/environments/:environmentKey/contexts/search

$ curl -X POST https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/contexts/search \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "_environmentId": "57be1db38b75bf0772d11384",
3   "items": [
4     {
5       "context": null,
6       "lastSeen": "2022-04-15T15:00:57.526470334Z",
7       "applicationId": "GoSDK/1.2",
8       "_links": {
9         "parent": {
10           "href": "/api/v2/projects/my-project/environments/my-environment",
11           "type": "application/json"
12         },
13         "self": {
14           "href": "/api/v2/projects/my-project/environments/my-env/contexts/organization:launch-darkly:user:henry?filter=applicationId:\"GoSDK/1.2\"",
15           "type": "application/json"
16         },
17         "site": {
18           "href": "/my-project/my-environment/context/organization:launch-darkly:user:henry",
19           "type": "text/html"
20         }
21       },
22       "_access": {
23         "denied": [
24           {
25             "action": "string",
26             "reason": {
27               "effect": "allow",
28               "resources": [
29                 "proj/*:env/*;qa_*:/flag/*"
30               ],
31               "notResources": [
32                 "string"
33               ],
34               "actions": [
35                 "*"
36               ],
37               "notActions": [
38                 "string"
39               ],
40               "role_name": "string"
41             }
42           }
43         ],
44         "allowed": [
45           {
46             "action": "string",
47             "reason": {
48               "effect": "allow",
49               "resources": [
50                 "proj/*:env/*;qa_*:/flag/*"
51               ],
52               "notResources": [
53                 "string"
54               ],
55               "actions": [
56                 "*"
57               ],
58               "notActions": [
59                 "string"
60               ],
61               "role_name": "string"
62             }
63           }
64         ]
65       },
66       "associatedContexts": 0
67     }
68   ],
69   "_links": {
70     "next": {
71       "href": "/app.launchdarkly.com/api/v2/projects/my-project/environments/my-environment/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351",
72       "type": "application/json"
73     },
74     "self": {
75       "href": "/api/v2/projects/my-proj/environments/my-env/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351",
76       "type": "application/json"
77     }
78   },
79   "totalCount": 100,
80   "continuationToken": "QAGFKH1313KUGI2351"
81 }

Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/api/contexts#filtering-contexts-and-context-instances). To learn more about contexts, read [Contexts and context kinds](https://launchdarkly.com/docs/home/observability/contexts#contexts-and-context-kinds).

Search for contexts

POST

/api/v2/projects/:projectKey/environments/:environmentKey/contexts/search

POST

/api/v2/projects/:projectKey/environments/:environmentKey/contexts/search

$ curl -X POST https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/contexts/search \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "_environmentId": "57be1db38b75bf0772d11384",
3   "items": [
4     {
5       "context": null,
6       "lastSeen": "2022-04-15T15:00:57.526470334Z",
7       "applicationId": "GoSDK/1.2",
8       "_links": {
9         "parent": {
10           "href": "/api/v2/projects/my-project/environments/my-environment",
11           "type": "application/json"
12         },
13         "self": {
14           "href": "/api/v2/projects/my-project/environments/my-env/contexts/organization:launch-darkly:user:henry?filter=applicationId:\"GoSDK/1.2\"",
15           "type": "application/json"
16         },
17         "site": {
18           "href": "/my-project/my-environment/context/organization:launch-darkly:user:henry",
19           "type": "text/html"
20         }
21       },
22       "_access": {
23         "denied": [
24           {
25             "action": "string",
26             "reason": {
27               "effect": "allow",
28               "resources": [
29                 "proj/*:env/*;qa_*:/flag/*"
30               ],
31               "notResources": [
32                 "string"
33               ],
34               "actions": [
35                 "*"
36               ],
37               "notActions": [
38                 "string"
39               ],
40               "role_name": "string"
41             }
42           }
43         ],
44         "allowed": [
45           {
46             "action": "string",
47             "reason": {
48               "effect": "allow",
49               "resources": [
50                 "proj/*:env/*;qa_*:/flag/*"
51               ],
52               "notResources": [
53                 "string"
54               ],
55               "actions": [
56                 "*"
57               ],
58               "notActions": [
59                 "string"
60               ],
61               "role_name": "string"
62             }
63           }
64         ]
65       },
66       "associatedContexts": 0
67     }
68   ],
69   "_links": {
70     "next": {
71       "href": "/app.launchdarkly.com/api/v2/projects/my-project/environments/my-environment/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351",
72       "type": "application/json"
73     },
74     "self": {
75       "href": "/api/v2/projects/my-proj/environments/my-env/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351",
76       "type": "application/json"
77     }
78   },
79   "totalCount": 100,
80   "continuationToken": "QAGFKH1313KUGI2351"
81 }

Search for contexts.

You can use either the query parameters or the request body parameters. If both are provided, there is an error.

To learn more about the filter syntax, read Filtering contexts and context instances. To learn more about contexts, read Contexts and context kinds.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

Query parameters

limitlongOptional

Specifies the maximum number of items in the collection to return (max: 50, default: 20)

continuationTokenstringOptionalformat: "string"

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

sortstringOptionalformat: "string"

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.

filterstringOptionalformat: "string"

A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](https://launchdarkly.com/docs/ld-docs/api/contexts#filtering-contexts-and-context-instances).

includeTotalCountbooleanOptional

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

Request

This endpoint expects an object.

filterstringOptional

A collection of context filters

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.

limitintegerOptional

Specifies the maximum number of items in the collection to return (max: 50, default: 20)

continuationTokenstringOptional

Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the next link instead, because this value is an obfuscated string.

Response

Contexts collection response

_environmentIdstring

The environment ID where the context was evaluated

itemslist of objects

A collection of contexts. Can include multiple versions of contexts that have the same kind and key, but different applicationIds.

_linksmap from strings to objects

The location and content type of related resources

totalCountinteger

The number of contexts

continuationTokenstring

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

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

Query parameters

limitlongOptional

Specifies the maximum number of items in the collection to return (max: 50, default: 20)

continuationTokenstringOptionalformat: "string"

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

sortstringOptionalformat: "string"

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.

filterstringOptionalformat: "string"

A comma-separated list of context filters. 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 contexts. Defaults to true.

Request

This endpoint expects an object.

filterstringOptional

A collection of context filters

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.

limitintegerOptional

Specifies the maximum number of items in the collection to return (max: 50, default: 20)

continuationTokenstringOptional

Response

Contexts collection response

_environmentIdstring

The environment ID where the context was evaluated

itemslist of objects

A collection of contexts. Can include multiple versions of contexts that have the same kind and key, but different applicationIds.

_linksmap from strings to objects

The location and content type of related resources

totalCountinteger

The number of contexts

continuationTokenstring

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

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

$	curl -X POST https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/contexts/search \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"_environmentId": "57be1db38b75bf0772d11384",
3	"items": [
4	{
5	"context": null,
6	"lastSeen": "2022-04-15T15:00:57.526470334Z",
7	"applicationId": "GoSDK/1.2",
8	"_links": {
9	"parent": {
10	"href": "/api/v2/projects/my-project/environments/my-environment",
11	"type": "application/json"
12	},
13	"self": {
14	"href": "/api/v2/projects/my-project/environments/my-env/contexts/organization:launch-darkly:user:henry?filter=applicationId:\"GoSDK/1.2\"",
15	"type": "application/json"
16	},
17	"site": {
18	"href": "/my-project/my-environment/context/organization:launch-darkly:user:henry",
19	"type": "text/html"
20	}
21	},
22	"_access": {
23	"denied": [
24	{
25	"action": "string",
26	"reason": {
27	"effect": "allow",
28	"resources": [
29	"proj/:env/;qa_:/flag/"
30	],
31	"notResources": [
32	"string"
33	],
34	"actions": [
35	"*"
36	],
37	"notActions": [
38	"string"
39	],
40	"role_name": "string"
41	}
42	}
43	],
44	"allowed": [
45	{
46	"action": "string",
47	"reason": {
48	"effect": "allow",
49	"resources": [
50	"proj/:env/;qa_:/flag/"
51	],
52	"notResources": [
53	"string"
54	],
55	"actions": [
56	"*"
57	],
58	"notActions": [
59	"string"
60	],
61	"role_name": "string"
62	}
63	}
64	]
65	},
66	"associatedContexts": 0
67	}
68	],
69	"_links": {
70	"next": {
71	"href": "/app.launchdarkly.com/api/v2/projects/my-project/environments/my-environment/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351",
72	"type": "application/json"
73	},
74	"self": {
75	"href": "/api/v2/projects/my-proj/environments/my-env/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351",
76	"type": "application/json"
77	}
78	},
79	"totalCount": 100,
80	"continuationToken": "QAGFKH1313KUGI2351"
81	}