Search for context instances

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Search for context instances.

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 context instances, read Context instances.

POST /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/search

Search for context instances

cURL

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": "{\"filter\": \"kindKeys:{\"contains\": [\"user:Henry\"]},\"sort\": \"-ts\",\"limit\": 50}",
  "sort": "-ts",
  "limit": 10,
  "continuationToken": "QAGFKH1313KUGI2351"
}
'

200

{
  "_environmentId": "57be1db38b75bf0772d11384",
  "items": [
    {
      "id": "b3JnOmxhdW5jaGRhcmtseQ",
      "context": "{\"kind\": \"user\", \"key\": \"context-key-123abc\", \"name\": \"Sandy Smith\", \"email\": \"[e-mail]\"}",
      "lastSeen": "2022-04-15T15:00:57.526470334Z",
      "applicationId": "GoSDK/1.2",
      "anonymousKinds": [
        "device",
        "privateKind"
      ],
      "_links": {
        "parent": {
          "href": "/api/v2/projects/my-project/environments/my-environment",
          "type": "application/json"
        },
        "self": {
          "href": "/api/v2/projects/my-project/environments/my-env/context-instances/organization:launch-darkly:user:henry?filter=applicationId:\"GoSDK/1.2\"",
          "type": "application/json"
        },
        "site": {
          "href": "/my-project/my-environment/context-instances/organization:launch-darkly:user:henry",
          "type": "text/html"
        }
      },
      "_access": {
        "denied": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ],
        "allowed": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ]
      }
    }
  ],
  "_links": {
    "next": {
      "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",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/projects/my-proj/environments/my-env/context-instances/organization:launch-darkly:user:henry-jacobs?limit=2",
      "type": "application/json"
    }
  },
  "totalCount": 100,
  "continuationToken": "QAGFKH1313KUGI2351"
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

Query Parameters

limit · integer<int64>

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

continuationToken · string<string>

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.

sort · string<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.

filter · string<string>

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.

includeTotalCount · boolean

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

Body

application/json

filter · string

A collection of context instance filters

Example:

"{\"filter\": \"kindKeys:{\"contains\": [\"user:Henry\"]},\"sort\": \"-ts\",\"limit\": 50}"

sort · 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.

Example:

"-ts"

limit · integer

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

Example:

10

continuationToken · string

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 instead, because this value is an obfuscated string.

Example:

"QAGFKH1313KUGI2351"

Response

200

application/json

Context instances collection response

_environmentId · string · required

The environment ID

Example:

"57be1db38b75bf0772d11384"

items · object[] · required

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

Show child attributes

_links · object

The location and content type of related resources

Show child attributes

Example:

{
  "next": {
    "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",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/projects/my-proj/environments/my-env/context-instances/organization:launch-darkly:user:henry-jacobs?limit=2",
    "type": "application/json"
  }
}

totalCount · integer

The number of unique context instances

Example:

100

continuationToken · string

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.

Example:

"QAGFKH1313KUGI2351"