Get context instances

GET

/api/v2/projects/:projectKey/environments/:environmentKey/context-instances/:id

GET

/api/v2/projects/:projectKey/environments/:environmentKey/context-instances/:id

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

{
  "_environmentId": "57be1db38b75bf0772d11384",
  "items": [
    {
      "id": "b3JnOmxhdW5jaGRhcmtseQ",
      "context": null,
      "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+equals+%22GoSDK%2F1.2%22",
          "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"
}

Get context instances by ID.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

idstringRequiredformat: "string"

The context instance ID

Query parameters

limitlongOptional

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

continuationTokenstringOptionalformat: "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.

sortstringOptionalformat: "string"Deprecated

Deprecated. This endpoint does not support sorting. Requests that include this parameter are rejected with a 400 response, so omit it.

filterstringOptionalformat: "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.

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](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 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

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error